![]() * input_argument The input argument passed into the functor * functor The functor to be called on the input argument * input_type The datatype of the input argument * cuspatial::logic_error if `input_argument` is negative or zero Do not use doxygen-style block comments T complicated_function(int first, double* second, float* third) ![]() * third This parameter is an output of the function * second This parameter is used both as an input and output * first This parameter is an input parameter to the function * int output = plicated_function(1,dptr,fptr) * U Short description of each template parameter * T Short description of each template parameter * Longer, more detailed description of the class. * Longer description of the source file contents. The following example covers most of the doxygen block comment and tag styles for documenting C++ code in libcuspatial. Although doxygen supports markdown and markdown supports HTML tags, the HTML support for doxygen's markdown is also limited. For example, there are some limitations on readability with '' character and pipe character '|' within a markdown table.Īvoid using direct HTML tags. In some cases a trade-off may be required for readability in the source text file versus the readability in the doxygen formatted web pages. The 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. These guidelines apply to documenting all libcuspatial C++ source files using doxygen style formatting although only public APIs and classes are actually published. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |