chiark / gitweb /
doxygen: support brief for enum values.
authorVladimír Vondruš <mosra@centrum.cz>
Tue, 14 Aug 2018 19:12:51 +0000 (21:12 +0200)
committerVladimír Vondruš <mosra@centrum.cz>
Tue, 14 Aug 2018 19:27:35 +0000 (21:27 +0200)
commit1f8ecd338d351baf540c12a685c81c2e982e3121
tree0cb58cfbb89fc86ca47b5ded933a149145853eab
parent2d7d3b5e1ae7f62e35203d2848e96a7836676d6f
doxygen: support brief for enum values.

Turns out the enum values can be documented like this:

    //! A value
    enum Enum {
        Value, //!< A value
    };

and the /// or //! comments, unlike /** */, are treated as brief by
doxygen. This is a completely valid use case and I don't want to force
users to a different syntax here, so here ya go.
doc/doxygen.rst
doxygen/dox2html5.py
doxygen/templates/details-enum.html
doxygen/test/compound_detailed/File.h
doxygen/test/compound_detailed/namespaceWarning.html
doxygen/test/contents_autobrief_cpp_comments/Doxyfile [new file with mode: 0644]
doxygen/test/contents_autobrief_cpp_comments/File.h [new file with mode: 0644]
doxygen/test/contents_autobrief_cpp_comments/File_8h.html [new file with mode: 0644]
doxygen/test/search/Dir/File.h
doxygen/test/test_contents.py
doxygen/test/test_search.py