search

vovkos / doxyrest

A compiler from Doxygen XML to reStructuredText -- hence, the name. It parses XML databases generated by Doxygen and produces reStructuredText for the Python documentation generator Sphinx.
MIT License
306 stars 23 forks source link

Static const field: Can we add the values as well? #17

Closed strasdat closed 5 years ago

strasdat commented 5 years ago

I very much like the documentation doxyrest creates by default. But it would be great if static const "fields" could also show the value. I do not want to force the values into the comments, since this is pretty redundant and prone to refactoring errors.

image

E.g. I would expect to see: static int constexpr DoF = 3;

http://strasdat.github.io/Sophus/class_Sophus_SO3Base.html#doxid-class-sophus-1-1-s-o3-base

vovkos commented 5 years ago

Good point, initializers should be displayed for variables/constants. Fixed.

Also, I can see you already use Doxyrest for documentation of your project -- nice! I noticed a glitch in the formatting of default parameters for template values (e.g. SO3Base::operator*=); added a quick fix which should take care of it, too.

strasdat commented 5 years ago

Awesome, thanks!