![]() I can also mention that I (for several reasons I won't bother to go into) don't wish to use the \example tag with external example code files. GitHub doxygen / doxygen Public Notifications Fork 1.2k Star 4.However, that's just my line of thought, there might be far better ones. copybrief or copydoc target not found when adding namespace ![]() As far as I can see the thing here is to find a tag which can be referenced by copydoc and which doesn't render any content on itself. So somewhere in the resulting documentation there's a page with some code completely out of context. This is actually as far as I have gotten, but I'm not satisfied with it since I don't know how to hide the dummy page 'ResourceExampleTag' I'm creating to copy from. code example in one place, reused in other places. I want to use copydoc, something like this: /** \page ResourceExampleTag So the code example is duplicated, not good. doxygenenum Directive Example Working Example This should work. void, purgeDocumentVersionHistory (String. void, restoreDocumentVersion (String docId, String versionId). In many cases I want to put in a small code example of how to use the function in a context, which often involves using a range of functions which all might be sufficiently depicted by the same code example, for instance: /** Aquires resource. void, copyDocument (String docId, String dstId). Let's say I have two documented functions: /** Aquires resource. The link command should end with an endlink command. The link command can be used to create a link to an object (a file, class, or member) with a user specified link-text. cpp file.I want to reuse a block of example code using the \copydoc tag. The links that are automatically generated by doxygen always have the name of the object they point to as link-text. I defined an ALIAS in my Doxyfile as: ALIASES = clipĪnd that does exactly what I want, including just the funciton tl_demo () from the. more than 10 times in the last second.Īnd I want to include it, but not have the #includes at the top. once we get here, we know that we haven't ticked scarce will be a gate to control some resource that shouldn't get called My source file Time_Limiter_example.cpp is: #include "stdafx.h" Here's what I've done, which seems to work for me. However, that's just my line of thought, there might be far better ones. end of code comment std::string copyDoc ///< copy (or refer) to docs elsewhere std::string. As far as I can see the thing here is to find a tag which can be referenced by copydoc and which doesn't render any content on itself. doxy Add doxygen file header to introspected-doxygen.h. So the code example is duplicated, not good. In many cases I want to put in a small code example of how to use the function in a context, which often involves using a range of functions which all might be sufficiently depicted by the same code example, for instance: /** Aquires resource. created for OPALS (version 2.5.0 (latest) / 15 June 2022) by doxygen 1.8.17. return a reference to contained value / T
0 Comments
Leave a Reply. |