doxygen

Indent all tags following h2 until next h2 is hit using CSS

跟風遠走 提交于 2020-02-03 16:47:07
问题 In our project I'd like to style our doxygen output differently. Currently the generated html looks like the following: <html> <body> <h1> Heading 1 </h1> <h2> Heading 2.1 </h2> <p> Paragraph 2.1.1 </p> <p> Paragraph 2.1.2 </p> <p> Paragraph 2.1.3 </p> <h2> Heading 2.2 </h2> <p> Paragraph 2.2.1 </p> <p> Paragraph 2.2.2 </p> <p> Paragraph 2.2.3 </p> </body> </html> The <h2> is only styled with a font-size attribute and all <h2> and <p> tags are aligned on the left side of the document. To let

force doxygen to pick one from versioned files

女生的网名这么多〃 提交于 2020-01-25 21:42:56
问题 Just started using doxygen today. How would you go about this. Given following dir structure -rootDir -dirA -dirAFile_ver01 -dirAFile_ver02 -dirAFile_ver03 -dirAFile_ver04 -dirB -dirBFile_ver01 -dirBFile_ver02 -dirBFile_ver03 -dirC -dirCFile_ver01 -dirCFile_ver02 My expectations from doxygen are to take only last version of file from single dir e.g. dirAFile_ver04 from dirA , dirBFile_ver03 from dirB etc. I've read about FILE_VERSION_FILTER tag, but I'm not able to make it work. Using CMD

How to make a preprocessor macro greedy?

回眸只為那壹抹淺笑 提交于 2020-01-24 05:47:10
问题 We have the following preprocessor macro. Its used to help with Doxygen documentation because Doxygen has troubles with C++ and some template typedefs: #if defined(DOXYGEN_PROCESSING) # define DOCUMENTED_TYPEDEF(x, y) class y : public x {}; #else # define DOCUMENTED_TYPEDEF(x, y) typedef x y; #endif It works great when X is a non-template or has only one template parameter. However, if X is a template with multiple parameters: DOCUMENTED_TYPEDEF(Foo<R,S>,Bar); Then it results in compile

How to specify image size in HTML Doxygen?

做~自己de王妃 提交于 2020-01-20 03:10:08
问题 I am trying to manually specify the image size in the HTML generated by Doxygen. However, as I read in the documentation, this can only happen if using LaTeX output. Anybody here knows any workaround? As an example, I would like to do something like this: \image html example.png "Caption" width=10px Thank you! 回答1: Put this in the CSS file "Doc/doxygen_html_style.css": div.image img[src="example.png"]{ width:100px; } And set the Doxygen config variable *HTML_EXTRA_STYLESHEET* to "Doc/doxygen

Include-guards and commented out Doxygen comments affect the output of Doxygen

我只是一个虾纸丫 提交于 2020-01-17 05:55:51
问题 The behavior of Doxygen 1.8.11 for the following example is really bizarre: File test.h : /// \file /// \namespace N1 /// Namespace N1. namespace N1 { #include "a.h" } // namespace int main() { return 0; } File a.h : /// \file /// \namespace N1::N2 /// Namespace N2 namespace N2 { #include "b.h" } // namespace File b.h : /// \file // class A does not appear without the commented Doxygen comments below! // /// \cond None #ifndef GUARD #define GUARD // /// \endcond /// Class A class A {}; // ///

How to open a file in Eclipse in an embedded fashion?

大憨熊 提交于 2020-01-16 08:27:40
问题 I would like to open a .chm file in Eclipse. But it does not support these files. If I wanted a workaround, how should I go about it? I have looked into writing plug-ins to do so. The only way I would be able to view .chm as an Eclipse Help Plug-in would be to convert .chm to DITA and then DITA to Eclipse help files. But there's no clear cut way to do this. There isn't much help online either. Any suggestions? I need an automate-able way to do this. I will have a .chm file (for documentation

Configure Doxygen to ignore the Source-Code Annotation Language (SAL)

*爱你&永不变心* 提交于 2020-01-15 09:42:38
问题 I have some classes that are documented with Doxygen. Additionally, they are annotated with Microsoft's Source-Code Annotation Language (SAL) to support static code analysis. //! The majestic class. class Foo { //! \brief do something //! \param [out] pResult The result value is stored here. //! \returns The return value Succcess indicates success. _Success_(return == Success) virtual Result_t DoSomething(_Out_ uint32_t *pResult) = 0; }; In this case, Doxygen reports a warning: argument

Configure Doxygen to ignore the Source-Code Annotation Language (SAL)

僤鯓⒐⒋嵵緔 提交于 2020-01-15 09:42:12
问题 I have some classes that are documented with Doxygen. Additionally, they are annotated with Microsoft's Source-Code Annotation Language (SAL) to support static code analysis. //! The majestic class. class Foo { //! \brief do something //! \param [out] pResult The result value is stored here. //! \returns The return value Succcess indicates success. _Success_(return == Success) virtual Result_t DoSomething(_Out_ uint32_t *pResult) = 0; }; In this case, Doxygen reports a warning: argument

Doxygen and typedefs inside namespaces

时光怂恿深爱的人放手 提交于 2020-01-15 06:18:08
问题 Could someone tell me what is wrong with this code so doxygen cannot handle? /*! \file Enumerator.h \brief Implements an Enumerator pointer for accessing linked list elements. */ #pragma once #ifndef __MSCL_ENUMERATOR_H__ #define __MSCL_ENUMERATOR_H__ namespace MSCL { /*! \typedef Enumerator Pointer to linked list data structure. \sa ArrayList::GetEnumerator, \sa List::GetEnumerator */ typedef void* Enumerator; }; #endif I need the Enumerator that is used by many methods as an argument type

Doxygen and typedefs inside namespaces

和自甴很熟 提交于 2020-01-15 06:16:08
问题 Could someone tell me what is wrong with this code so doxygen cannot handle? /*! \file Enumerator.h \brief Implements an Enumerator pointer for accessing linked list elements. */ #pragma once #ifndef __MSCL_ENUMERATOR_H__ #define __MSCL_ENUMERATOR_H__ namespace MSCL { /*! \typedef Enumerator Pointer to linked list data structure. \sa ArrayList::GetEnumerator, \sa List::GetEnumerator */ typedef void* Enumerator; }; #endif I need the Enumerator that is used by many methods as an argument type