![]() ![]() 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. includeĮmbedded markdown files and source code directories to process Here are some of the custom options in the Doxyfile for libcudf. 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 libcudf 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) 2021-2022, NVIDIA CORPORATION. The following is the license header comment that should appear at the beginning of every C++ source file. The copyright comment is included here but may also be mentioned in a coding guideline document as well. This is not what I wish to achieve in this case since I want to show how this class can be used in a fully working example and not only in a usage instruction.These guidelines apply to documenting all libcudf C++ source files using doxygen style formatting although only public APIs and classes are actually published. And the example is linked to this member function. In the doxygen example of they reference an example to a member variable. How can I have a detailed description of the class AND a link to a file of an example which shows the usage of the class in a detailed manner? If I just put the at the end of the detailed description the detailed description is applied to the example. Detailed description of the test classĪnd want to include an example to a file called testexample.cpp I included a detailed description of my templated class as follows: /** A test class. I am using doxygen version 1.8.8 to build the C++ documentation. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |