h file) begining with a paragraph (or more) describing the overview of the class. The file on how attributes work is found here:Įach class has a description (in the appropriate. $a/src/documentation/developer/how_to_document.doxygen.doxygen extenssion.įor example, this file " how_to_document.doxygen" is found here: If the documentation is an overview of programming concepts, or high level generic system information, then it belongs in the src/documentation directories (either under the "user" or "developer" dirs, as appropriate). If the concept is specific to one library (i.e., how attributes work) then the documentation belongs in that libraries include directory. The exception to this rule is for high level concepts (e.g., those that are not directly related to a specific data structure). DOXYGEN FILE HEADER EXAMPLE CODEMost documentation is inlined in the appropriate header or C code file. And finally: All code should be reviewed before checking in.The example program should contain a page (or more) of detail on how the program works and what it shows the user. Every major addition of functionality requires an example program be check in with it to demonstrate the functionality.(For very short well named functions, this can be a very concise description). Every function should have a paragraph (or more) describing the input, output, and general algorithm.Every class variable should have a short description.It should be specific enough to allow a user/developer to quickly decide if the class has the necessary functionality and it should allow someone to come in and add code to the class or recode the entire implementation with out having to look at a line by line analysis of the source code. What level of commenting is required? The overview comment should set the stage detailing what the class can and cannot do. This is because, every function must be commented (with a function comment block) above the actual code of the function, usually found in the. Each function does not have to be commented in the header file. h file) each variable should be commented. Every function must be commented, every variable must be commented. This includes a class header describing the overall view of the class, what it does, (what it doesn't do), what it contains, what it relies on, etc. DOXYGEN FILE HEADER EXAMPLE HOW TOThis document explains what is expected in the realm of documentation for alpha11 developers and how to utilize the doxygen documentation system.Įvery class must be fully documented. Developer Documentation Standards and Requirements Main Page Modules Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pagesĭeveloper Documentation Standards and Requirements
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |