![]() ![]() Go to the next section or return to the index. If this is still not enough doxygen also supports a subset of the HTML markup language. ![]() See XML Commands for the XML commands supported by doxygen. XML markup as specified in the C standard. ![]() Also, if you'll notice, all the examples (i think) show documentation in header files, which lack any implementation which leads me to believe that documentation is intended for the header files, but the tool gives you the flexibility to put is in source files as well. See Special Commands for a complete overview of all commands supported by doxygen. That would require actually looking at the function source (which is also available in the doxygen generated files). I believe the purpose of doxygen is to assist in documentation that is easily searchable to allow coders to find where things are and look up what they do (and what parameters are passed into it, what it returns, etc) to learn how to use them, but not how its actually implemented. doxygen Run with default cong le.doxygen Run with.doxygen -g Generate.This makes some sense because the nitty gritty of HOW a function works (its implementation) is usually not desired. Doxygen ( reads a conguration leto control source code processing and documentation outputformats, the default lename isDoxyfile. "Doxygen allows you to put your documentation blocks practically anywhere ( the exception is inside the body of a function or inside a normal C style comment block)." From the online manual in the "Documentation at other places" section: ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |