Including files Into Doxygen Comments
Joel Sherrill <[email protected]>
| Newsgroups | gmane.text.doxygen.devel |
|---|---|
| Message-ID | <[email protected]> |
Hi, This is bordering on a user question, but I think I may end up having to implement this so here goes. I was looking for a way to have some documentation for a method in a separate file. All of the various include and example commands I see assume they are adding some markup like verbatim or before and after. + @include - @code + @includelineno - ditto + @verbinclude - @verbatim + @htmlinclude - @htmlonly I'm looking at a use case for someone where they have multiple language bindings and generate Java, C, and C++ API guides but a significant portion of the text is shared. They have a custom post-processing to insert the external files into the generated output. It just feels wrong to post-process and seems like something Doxygen should just be able to do. Any thoughts on this? I can't be the first person to think this was useful. :) If useful, what would be a good command name and existing comment to base it upon. -- Joel Sherrill, Ph.D. Director of Research& Development [email protected] On-Line Applications Research Ask me about RTEMS: a free RTOS Huntsville AL 35805 Support Available (256) 722-9985 ------------------------------------------------------------------------------ All of the data generated in your IT infrastructure is seriously valuable. Why? It contains a definitive record of application performance, security threats, fraudulent activity, and more. Splunk takes this data and makes sense of it. IT sense. And common sense. http://p.sf.net/sfu/splunk-d2d-c2