documentation practices --- having the output consist of an actual
human-written documentation instead of just autogenerated lists. If you
*really* want to have them included in the output, you can enable them
- using a default-to-off :ini:`SHOW_UNDOCUMENTED` option, but there are some
+ using a default-to-off :py:`SHOW_UNDOCUMENTED` option in ``conf.py`` (or
+ :ini:`M_SHOW_UNDOCUMENTED` in the ``Doxyfile``), but there are some
tradeoffs. See `Showing undocumented symbols and files`_ for more
information.
- Table of contents is generated for compound references as well, containing
In some cases, however, it might be desirable to show undocumented symbols as
well --- for example when converting an existing project from vanilla Doxygen
to m.css, not all APIs might be documented yet and thus the output would be
-incomplete. The :py:`SHOW_UNDOCUMENTED` option unconditionally makes all
+incomplete. The :py:`SHOW_UNDOCUMENTED` option in ``conf.py`` (or
+:ini:`M_SHOW_UNDOCUMENTED` in the ``Doxyfile``) unconditionally makes all
undocumented symbols, files and directories "appear documented". Note, however,
that Doxygen itself doesn't allow to link to undocumented symbols and so even
though the undocumented symbols are present in the output, nothing is able to