![]() variables and enum entries If they require just a short comment, you should document them inline. There are two exceptions: files They should be documented at the beginning of the file. make docs To let doxygen generate the HTML documentation. Generally, the comment should be placed right above the block of code. Then it may look fine, but I don't know if it will be semantically correct any more, because I don't know what that extra asterisk would do. configure -help Compile the program by running make: make The program should compile without problems and the binaries (doxygen and optionally doxywizard) should be available in the bin directory of the distribution. markdown to FILEPATTERNS in the Doxyfile. ![]() * #include "MyFile.h" -> file will be included anyway. I found the solution (using Doxygen 1.8+) Change the file extension to. #include "MyFile.h" -> file will be included anyway. The documentation is discussing a renderer shading language that understands #include and single-line comments but not block comments, and wants to say:īlock comment lines are not supported, but may not matter if the included file does not close the block: /* In some cases that might be acceptable, but I think that would be a problem for me, so let me explain why. It was suggested in comments that I could at least align the extra asterisk with the ones that are supposed to be there, making the output look better. How can I make both Doxygen and C++ happy? This version won't confuse the C++ compiler, but now Doxygen adds an extra star. /-delimited Doxygen block: /// documentation While looking at the alternatives I saw a reference to an existing mechanism in SRecode that could generate the correct comments with srecode-document-insert-function-comment. Won't know that it should ignore the inner */. I was looking for a way to automatically generate doxygen comment blocks for functions in existing source files. You have to at least have file specified if you want documentation generated, but other. In general, these Doxygen style function comment blocks should only be placed in the class header file, not the source file, in order to avoid confusion as to. ![]() automatically insert this for you on each new line, so you can type. That's clearly going to be a problem: Doxygen will do the right thing, but a C++ compiler as that is compatible with how our standard SAS comment blocks work. commands to create and update documentation comments (for single code elements. Let's say I want to show a /* - */ delimited comment block inside a code block in aĭoxygen documentation block in C++ code.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |