search

randombit / botan

Cryptography Toolkit
https://botan.randombit.net
BSD 2-Clause "Simplified" License
2.6k stars 570 forks source link

Display the module name in the doxygen modules #4333

Closed reneme closed 2 months ago

reneme commented 2 months ago

This displays the "module identifier" (as used in --enable-modules=) in Doxygen's module overview. The identifier is incorporated into the @brief of each module. Not optimal, as it is displayed in too many places, but I think it is crucial for the usefulness of this list: See also this user question: https://github.com/randombit/botan/discussions/4332#discussioncomment-10532941

Result looks like this:

image

Other places this is shown:

image

image

coveralls commented 2 months ago

Coverage Status

coverage: 91.283% (+0.003%) from 91.28% when pulling 5741c853e401c57c80f636f6bb60d042284d7ae2 on reneme:doc/module_name into a7f2305ae71c1c7e877f1663becfe9f980614751 on randombit:master.