Boost logo

Boost :

Subject: Doxygen generates documentation for everything?
From: Mateusz Loskot (mateusz_at_[hidden])
Date: 2018-11-28 18:05:05


Hi,

Doxygen reports ~3500 warnings about not documented entities.
Here is full log:
https://gist.github.com/mloskot/6ba3827d01a34204a86ddd24c2fd3ea1

Do we really need to generate documentation for all headers;
for namespace boost::gil::detail?

If we want to indeed exclude some bits, for example,
here is how it is usually done:

https://github.com/boostorg/geometry/blob/develop/doc/doxy/Doxyfile#L312-L323
https://github.com/boostorg/geometry/blob/develop/include/boost/geometry/algorithms/detail/centroid/translating_transformer.hpp#L39-L40

Comments, ideas, actions?

Best regards,

-- 
Mateusz Loskot, http://mateusz.loskot.net

Boost list run by Boost-Gil-Owners