![]() If you for some reason have a need to define new commands you can do so by means of an alias definition. that can be used to enhance or structure the documentation inside a comment block. When used as a documentation generator, Doxygen extracts information from specially-formatted comments within the code. Simple aliases Aliases with arguments Nesting custom command Doxygen provides a large number of special commands, XML commands, and HTML commands. Doxygens tags are words preceeded by either a backslash * or by an at symbol * * */ #ifndef _BOX_PROTOTYPES_DOXYGEN_H # define _BOX_PROTOTYPES_DOXYGEN_H # include # include # include # include # include "local_header1.h" # include "local_header2.h" /** * Use brief, otherwise the index won't have a brief explanation. Doxygen (/ d k s i d n / DOK-see-jn) is a documentation generator and static analysis tool for software source trees. * * Here typically goes a more extensive explanation of what the header * defines. Change the code to print a warning if a multi-line \brief is encountered. markers, from subsequent lines until an explicit termination feature is. (I'm using \li \c now and\c will work, too, I just don't understand the reasoning that does not. Using in the aliases does the correct thing and according to the documentation is equivalent to . The parsing tool Yacc (or its replacement Bison) is also used, but only for minor tasks the bulk of language parsing is done by native C code. For lexical analysis, the standard tool Lex (or its replacement Flex) is run via approximately 35,000 lines of lex script. the \brief command will include all text, including the source code comment. HTML does not care about pure newlines in the code (neither does Latex) so there would be no point at all to use in aliases. Doxygen is written in C , and consists of around 300,000 source lines of code. * * * * You should have received a copy of the GNU Lesser General Public * * License along with Box. See the * * GNU Lesser General Public License for more details. These next few lines will form a comment block To start a new paragraph add an empty line To end the comment block type asterik and then forward slash. * * * * Box is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. /////This line will be included in the Doxygen comments for this function/class/file Commenting multiple lines is just as easy. * * * * Box is free software: you can redistribute it and/or modify it * * under the terms of the GNU Lesser General Public License as published * * by the Free Software Foundation, either version 3 of the License, or * * (at your option) any later version.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |