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. * * Here typically goes a more extensive explanation of what the header * defines. * ****************************************************************************/ /** * doxygen_c.h * My Self * * File containing example of doxygen usage for quick reference. Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, and to some extent D. Example: deprecated as of Drupal 7.3, will be removed in Drupal 8.0. If you need more than one line, indent subsequent lines. * * * * You should have received a copy of the GNU Lesser General Public * * License along with Box. Immediately after the tag (on the same line), describe which version the item was deprecated in, when it will be removed, and an explanation of reasons and/or what to use instead as appropriate. See the * * GNU Lesser General Public License for more details. * * * * 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. * * * * 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. The Doxygen structural command to use is mainpage as shown in the example above. Doxygen will pass the text on to dot and include the resulting image (and image map) into the output. I have been using Doxygen for a while now, but I keep forgetting bit and pieces of it. Then calling depfun anywhere in your code will emit a diagnostic message. **************************************************************************** * Copyright (C) 2012 by Matteo Franchin * * * * This file is part of Box. There is now a large collection of VTK Examples that showcase VTK features. If you are using GCC or clang to compile your code you could manually annotate functions.
0 Comments
Leave a Reply. |