doxygen

问题 I would like to write a Doxygen comment that names the file in which the comment occurs. Rather than write the filename explicitly, I would like Doxygen to supply me with it. Thus, if I change the name of the file, or move some of the content into a different file, I don't need to change hard-coded instances of the name. For a concrete example, let's say I'm adding comments to functions in array.hpp, and I want the comment for certain functions to say "This function should only be used within

问题 I would like to write a Doxygen comment that names the file in which the comment occurs. Rather than write the filename explicitly, I would like Doxygen to supply me with it. Thus, if I change the name of the file, or move some of the content into a different file, I don't need to change hard-coded instances of the name. For a concrete example, let's say I'm adding comments to functions in array.hpp, and I want the comment for certain functions to say "This function should only be used within

问题 Does a command exist, like \deprecated , but to mark overridden functions? Java has an annotation @override for functions you have overridden. I would like to do the same in C++, so that I can to see the superclass functions I've overridden. At best, the documentation page should also show all class member functions, which are inherited, but not explicitly overridden with hyper-links to the superclass functions. I know there is a way to copy the documentation from the superclass method. But I

问题 I have a simple method with a comment I want to use as an example in my doxygen mainpage: \code void showNum(int numToDisplay){ // This is just a method to display a value. std::cout<<"Displaying Number "<<numToDisplay<<std::endl; } \endcode When a generate the docs, the mainpage will show the code example correctly but the comment will be all the way to the left edge of the main page. What character(s) do I use to force the comment to maintain its justification and display? Thanks in advance

问题 Given some packages foo.bar.project.something.FirstModule foo.bar.project.something.SecondModule , etc. They all have that long foo.bar.project.something in common. How do I tell doxygen to hide (or at least shorten) those common package names and only print FirstModule.SomeClass and SecondModule.MyInterface in its output? 回答1: You could set HIDE_SCOPE_NAMES to YES, but that will probably also strip FirstModule and SecondModule. An alternative is to write a simple input filter (see INPUT

问题 I want to reuse a block of example code using the \copydoc tag. To explain the problem. Let's say I have two documented functions: /** Aquires resource. */ Resource* AquireResource( int id ); /** Releases resource.*/ void ReleaseResource( Resource* res ); 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

问题 I am using Doxygen to generate some API docs for a C# project I am working on. I have quite a bit of "internal" functionality in this project and don't want Doxygen producing these signatures in the generated html it produces. I have tried enabling HIDE_FRIEND_COMPOUNDS but this still results in my internal classes being exposed in the generated documentation. Does anyone know how to do this? 回答1: Addon to Mac H's answer, you have to set these additional configuration parameters to make it

问题 I would like to be able to edit LaTeX parts of some Doxygen comments externally with some suitable editor. I would use that only for complex environments. To do that, I figured I can have LaTeX-only files and include them from Doxygen. I did create Doxygen aliases for \begin and \end to make the syntax compatible. (For example, I know how to set-up Emacs/AUCTex for working with LaTeX snippets that have no preamble and document structure.) Is there a way to include the contents of a .tex file

问题 I'm having issues with Doxygen recognizing namespaces and modules. I believe the issue surrounds whether to place the \addtogroup within the namespace or outside the namespace. Example 1, outside the namespace: /*! * \addtogroup Records * @{ */ //! Generic record interfaces and implementations namespace Records { //! Describes the record interface class Interface; } // End namespace Records /*! @} End of Doxygen Groups*/ Example 2 - within namespace //! Generic record interfaces and

问题 Roxygen is inspired by the Doxygen documentation system that is used by C, C++ programmers. I have used Doxygen and I find it really easy to document any program as long as you have the doxygen comment. It also generate call graphs for functions and classes. I thought roxygen would work the same way but when I search for roxygen help, I only find solution to documenting R packages. I have checked Hadley Wickham's online roxygen2 help but that does not describe anything about the R script