DOXYGEN DOCUMENTATION CODE
dox documentation in the source code documentation (or vice-versa). You can use various Doxygen commands to link back to the documentation of the actual source code, and you can also insert a copy of the.
dox files would contain documentation generated from corresponding. dox files from your code before calling doxygen. Write a "Doxygen runner" that would automatically generate.(One odd behavior I dislike is that the \code command seems to strip leading spaces, so you wouldn't get indentation to work correctly.) I'm not sure where Doxygen would put these comments or how they'd look they might be pretty ugly, unfortunately. Then write a filter (see FILTER_PATTERNS) to replace this string with \code \endcode where is the next line of code that the filter sees. Put some sort of special string (say, for instance, DOXY_INLINE_CODE) in the Doxy comments that should be associated with a single line of code.There are two ways I can think of for accomplishing this: I'm quite sympathetic to your plight, but as far as I can tell, Doxygen really is only designed to document specific code-objects (files, classes, namespaces, variables, etc) rather than arbitrary lines of code.Īt the moment, the only possibility I can think of for circumventing this shortcoming is to generate comments that include the actual code that you're wanting to document via the \code command. Void ()Īny better ideas for implementing in-line test step documentation? I don't care so much about the steps not appearing in the test list, we can live with just the references to the functions. Void ()Ī method for testing doxygen method documentation. ** A method for testing doxygen method documentation code that may or may not be in sync with header Of note, I'm using the RTF output format. I'm trying to use doxygen to document my unit tests, but I'd like to document them in-line with the code instead of in the test header to reduce copy/paste errors when making similar tests.
0 kommentar(er)
