grouporder documentation update

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

grouporder documentation update #40

Closed ol-andreyizrailev closed 2 years ago

ol-andreyizrailev commented 3 years ago

Hello, I think that the documentation in doc/manual/rst/group-order.rst is incomplete and a little bit misleading.

To correctly pass an argument to an alias it should be placed in braces: \grouporder{1} instead of \grouporder 1.
To make the whole thing work INTERNAL_DOCS tag in the Doxyfile should be set to YES

Please, mention it in the documentation. It took me a while to figure this out :-)

vovkos commented 2 years ago

Thank you for the report, and apologies for the delay. Documentation updated accordingly.