6/28/2023 0 Comments Copydoc doxygenThe "path fragment" argument should include the directory name and enough of the path to be unique with respect to the other directories in the project. Indicates that a comment block contains documentation for a directory. ![]() See also: page Grouping, sections \ingroup, \addtogroup, and \weakgroup. The argument should be a single-word identifier. You can also use groups as members of other groups, thus building a hierarchy of groups. This can be used to categorize classes, files or namespaces, and document those categories. Indicates that a comment block contains documentation for a group of classes, files or namespaces. This is to test the documentation of defines.Ĭomputes the absolute value of its argument \a x. Note that the last two arguments can also be specified using the \headerfile command. ![]() Sharp brackets are used if just the name is given. With the argument you can also specify how the include statement should look like, by adding either quotes or sharp brackets around the name. This can be useful if the include name is not located on the default include path (like ). The argument can be used to overwrite the name of the link that is used in the class documentation to something other than. If the header-file is specified, a link to a verbatim copy of the header will be included in the HTML documentation. Optionally a header file and a header name can be specified. Indicates that a comment block contains documentation for a class with name. The arguments are equal to the \class command. See also: section \callgraph.įor Objective-C only: Indicates that a comment block contains documentation for a class category with name. Note: The completeness (and correctness) of the caller graph depends on the doxygen code parser which is not perfect. The caller graph will be generated regardless of the value of CALLER_GRAPH. When this command is put in a comment block of a function or method and HAVE_DOT is set to YES, then doxygen will generate a caller graph for that function (provided the implementation of the function or method calls other documented functions). Note: The completeness (and correctness) of the call graph depends on the doxygen code parser which is not perfect. The call graph will be generated regardless of the value of CALL_GRAPH. When this command is put in a comment block of a function or method and HAVE_DOT is set to YES, then doxygen will generate a call graph for that function (provided the implementation of the function or method calls other documented functions). See also: page Grouping, sections \defgroup, \ingroup, and \weakgroup. ![]() * Additional documentation for group `mygrp' The title is optional, so this command can also be used to add a number of entities to an existing group using and like this: Structural indicators -ĭefines a group just like \defgroup, but in contrast to that command using the same more than once will not result in a warning, but rather one group with a merged documentation and the first title found in any of the commands. Unrecognized commands are treated as normal text. See the License for the 00018 * specific language governing permissions and limitations 00019 * under the License. You may obtain a copy of the License at 00011 * 00012 * 00013 * 00014 * Unless required by applicable law or agreed to in writing, 00015 * software distributed under the License is distributed on an 00016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 00017 * KIND, either express or implied. The ASF licenses this file 00008 * to you under the Apache License, Version 2.0 (the 00009 * "License") you may not use this file except in compliance 00010 * with the License. See the NOTICE file 00006 * distributed with this work for additional information 00007 * regarding copyright ownership. 00001 /** 00002 * 00003 * = 00004 * Licensed to the Apache Software Foundation (ASF) under one 00005 * or more contributor license agreements.
0 Comments
Leave a Reply. |