search

boostorg / array

Boost.org array module
http://boost.org/libs/array
21 stars 50 forks source link

boost::array javadocs #17

Open alandefreitas opened 2 years ago

alandefreitas commented 2 years ago

This PR adds javadocs to array.hpp. This is the output preview with b2 + doxygen.

Unfortunately, the b2 doxygen rule does not support member grouping, which would nicely split the member functions like this, which is also closer to cppreference for std::array.

In fact, the rule removes member groups from the output, so these javadocs had to be replaced by simple comments identifying the groups.

alandefreitas commented 2 years ago

@pdimov just warned me the notes are wrong

alandefreitas commented 2 years ago

@pdimov just warned me the notes are wrong

Squashed and pushed!

Output preview: https://alandefreitas.github.io/boost-array-docs/boost/array.html

Example: https://github.com/alandefreitas/array/blob/54fe87b664c3b30d809ec406f04227625705c7b2/include/boost/array.hpp#L127