7/18/2023 0 Comments Copydoc doxygenThe doxygen tool supports a limited set of markdown format in the comment block including links, tables, lists, etc. Any text on these lines, including tag declarations, should start after a single space after the asterisk. See the Example section below.Įach line in the comment block between the /** and */ lines should start with a space followed by an asterisk. The block may be indented to line up vertically with the item it documents as appropriate. The block must be placed immediately before the source code line to which it refers. Do not add dashes - or extra asterisks ***** to the first and last lines of a doxygen block. **ĭoxygen comment blocks start with /** and end with */ only, and with nothing else on those lines. Use the following style for block comments describing functions, classes and other types, groups, and files. Versions are updated automatically at each release Links to external documentation tagfiles. Wildcard pattern to exclude paths / filenames OptionĮmbedded markdown files and source code directories to process Here are some of the custom options in the Doxyfile for libcuspatial. The doxygen process can be customized using options in the Doxyfile. This document provides guidance on which commands/tags to use and how to use them in the libcuspatial C source code. There are almost 200 commands (also called tags in this document) that doxygen recognizes in comment blocks. Doxygen recognizes and parses block comments and performs specialized output formatting when it encounters doxygen commands. The doxygen tool is used to generate HTML pages from the C comments in the source code. 2019-2021)Ĭhanging the copyright year may not be necessary if no content has changed (e.g. A modified file should span the year it was created and the year it was modified (e.g.A new file should have the year in which it was created.The comment should start with /* and not /** so it is not processed by doxygen.Īlso, here are the rules for the copyright year. * See the License for the specific language governing permissions and * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * distributed under the License is distributed on an "AS IS" BASIS, * Unless required by applicable law or agreed to in writing, software * You may obtain a copy of the License at * you may not use this file except in compliance with the License. * Licensed under the Apache License, Version 2.0 (the "License") * Copyright (c) 2022, NVIDIA CORPORATION. The following is the license header comment that should appear at the beginning of every C source file. QUrl ( "mydata://image.These guidelines apply to documenting all libcuspatial C source files using doxygen style formatting although only public APIs and classes are actually published. Note that the lines containing the block markers will not be included, so the output will be: QUrl ( "mydata://image.png" ), QVariant (image ) ) //! fill (qRgb ( 255, 160, 128 ) ) //! ĭocument - >addResource (QTextDocument :: ImageResource, QImage image ( 64, 64, QImage :: Format_RGB32 ) This is used to delimit the quoted code in the relevant snippet file as shown in the following example that corresponds to the above \snippet command: The text following the file name is the unique identifier for the snippet. The root is setted in the EXAMPLE_PATH in the Doxygen configuration file. To use a \snippet you will call a unique identifier of a file, you should reference the file and directory. This command can be used to quote only a fragment of a source file \copydoc Terralib.h //This tag copy the \brief and the \details of the file */ #ifndef _TERRALIB_COMMON_INTERNAL_TERRALIB_H #define _TERRALIB_COMMON_INTERNAL_TERRALIB_H // TerraLib #include "Config.h" #include "Singleton.h" // STL #include #include /*! \copyright GNU Lesser General Public License. You can also use the tag "\snippet" of Doxygen to put If you use resources you should remember to copy it You can, and should, use the most common HTML tags, like \details starts the detailed description that you can write more about your code. \brief Starts a paragraph that serves as a brief description To document a class, you can start using tags like \file, \class, \brief, \details, \version, \author, \date and \copyrights as exemplified below:
0 Comments
Leave a Reply. |