![]() Also, the sed command used in that answer does not work for me. Type opening triple quotes, and press Enter, or Space. I think that the latter ( INPUT_FILTER) is actually more appropriate here. Create documentation comments Last modified: 11 November 2022 Creating documentation comments for Python functions To create documentation comment for a Python function Place the caret after the declaration of a function you want to document. ![]() However, that answer used the FILE_VERSION_FILTER configuration option rather than INPUT_FILTER. markdown file) then you can also explicitly indicate the language, by putting the file extension typically that doxygen associated with. If it is unclear from the context which language is meant (for instance the comment is in a. 1 Answer Sorted by: 8 If you look into syntax/doxygen.vim you can read in the preamble of the file that currently only cpp, c, idl, doxygen and php files are supported. Note: This last point was inspired by the accepted answer to the question Getting doxygen and MSVC TODO tags to work together. If this part of a Python file for instance, the syntax highlight will be done according to the Python syntax. It is recommended that a blank line be placed before and after the code block. The closing set must contain the same number and type of characters as the opening set. This substitution is made internally by doxygen only: your source files are not modified on disk. Fenced code blocks begin with three or more backticks ( ) or tildes ( ) on a line by themselves and end with a matching set of backticks or tildes on a line by themselves. This filter replaces all instances of // FIXME (with any amount (or none) of whitespace between // and FIXME) with /// \todo. This option defines a command that is applied to each of your source files before doxygen builds the documentation, so we can define a command which replaces instances of TODO and FIXME with valid doxygen markup. The problem here is that you have to prefix your aliases with the \ (or symbol and begin the comment with three leading forward slashes which, if you want to leave the FIXMEs in your code as they are, is not an option.įinally, an alternative method, and what I think you are looking for, would be to preprocess your source files using the INPUT_FILTER configuration file option. Which will allow you to write \FIXME in your source code and the comments prefixed with \FIXME will be included in you todo list in the final documentation. Generally one can define custom tags (like FIXME) by defining an alias in the Doxygen configuration file. This can be used to add new todo items to your source code. ![]() See point three on the second list in the special documentation blocks section of the doxygen documentation. Note the three forward slashes, not the usual two. ![]() \todo) you would use /// \todo Some (optional) text There are a number of examples and methods we can use:įor a one line comment with valid doxygen commands (e.g. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |