![]() If you like to break a line, then break it twice. All spaces and line breaks are compressed into a single space. If it accepts input parameters and returns some value, all of them should be explained.ĭo not add a data type before parameter or any other characters besides spaces. You can accomplish what you are looking for by using the HTMLHEADER and HTMLFOOTER tags. Provide enough information about purpose, functionality and limitations of documented items, as you would like to see them documented when reading the code by others.ĭocumentation of function should describe what this function does. ![]() When writing code for this repository, please follow guidelines below.ĭocument all building blocks of code: functions, structs, typedefs, enums, macros, etc. With these tools the above piece of code renders like below: Go for it! For example if the source file is: WebGenerate Doxygen Comments in VS Code. The ultimate goal is to ensure that all the code is consistently documented, so we can use tools like Sphinx and Breathe to aid preparation and automatic updates of API documentation when the code changes. Doxygen c file header include parsed header into doxygen input to avoid. To get familiar with available features, please check data rich and very well organized Doxygen Manual. It also gives you great flexibility on level of details to include in documentation. ![]() Typical comment block, that contains documentation of a function, looks like below.ĭoxygen supports couple of formatting styles. 1 Answer Sorted by: 1 If you want Doxygen recognizes a file to insert it in documentation, you should use / <- (this format is recognized by Doxygen) file nameoffile. ** * ratio this is oxygen to air ratio */ĭoxygen is phrasing the code, extracting the commands together with subsequent text, and building documentation out of it.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |