The reason for this is that usually the members of a class are critical for its state, so you desperately want to document those, as derived classes might use protected members for example.įunctions on the other hand don't need such documentation for their local variables. Local variables are not members and thus not covered by doxygen. Members are values in a class or struct (or however your language might call it). The member documentation syntax is meant for, well, members. generating the documentation for the class definitions (the member variable. 13 hours ago &0183 &32 BERKELEY Ex-KTVU anchor Frank Somerville was arrested Monday night in Berkeley after getting into a fight with a family member, according to jail records and media reports. Instead of getting some description of the variable in the documentation, I get this: 2.1.1 Function Documentation 2.1.1.1 void foo ( void ) To use Doxygen, you write comments in code using the format that Doxygen. Or int var ///< Brief description after the member This is done as follows: int var //!< Brief description after the member Most often one only wants to put a brief description after a member. Note that this also works for the parameters of a function. The generated documentation makes easier to navigate and understand the code as it may contain all public functions, classes, namespaces, enumerations, side notes and code examples. For this purpose you have to put an additional < marker in the comment block. Doxygen is a tool that can generate project documentation in html, pdf or Latex from code comments formatted with Doxygen markup syntax. Note the extra asterisk () in line 1 of the first option and extra slash symbol (/), i.e. The 2 simplest methods to include in C source code are / comments / And /// Comments. If you want to document the members of a file, struct, union, class, or enum, it is sometimes desired to place the documentation block after the member instead of before. Doxygen supports several methods for incorporating documentation inside the comments. The doxygen documentation says: Putting documentation after members I'm trying to document my C code with doxygen, however using the "documentation after members" style doesn't seem to work for me.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |