doxygen

Is there a way to embed <script> content into a Doxygen \mainpage section?

ⅰ亾dé卋堺 提交于 2019-12-30 05:09:45
问题 I would like to introduce some javascript <script>xxx</script> content into my generated index.html in order to add reddit and facebook "like" buttons to my project's main page. Is there a way to accomplish this automatically using Doxygen? Thanks, SetJmp 回答1: You can use @mainpage in combination with an @htmlonly...@endhtmlonly block. Here is an example: /** @mainpage My Script Page Here is an embedded script: @htmlonly <script type="text/javascript"> function displayDate() { document

How to get a single PDF document from Doxygen?

旧城冷巷雨未停 提交于 2019-12-29 11:46:14
问题 When I generate Doxygen documentation in PDF format, I get plenty of different files with a single diagram in each. Is it possible to obtain a single PDF document, organized as a book, roughly as the HTML version? Is it possible to get it automatically, i.e. without dealing manually with the latex files? Thank's! 回答1: See Converting a LaTeX document to a PDF document. When Doxygen is finished processing, in the latex directory there's a file called 'refman.tex'. There are three ways you can

Doxygen C# XML comments: multiply enum's with same name and different scope got merged?

懵懂的女人 提交于 2019-12-25 03:38:14
问题 I have very strange problem with Doxygen: I used it to create documentation from XML tags of my C# code as suggested in some other StackOverflow question. Basically heres the situation: //file: Foo1 public class Foo1 { public enum Bar { Bar1, Bar2 } } //file: Foo2 public class Foo2 { public enum Bar { Bar3, Bar4 } } And in final docs generated by Doxygen I have: Foo1 Class Reference (...) Public Types enum Bar{ Bar1, Bar2, Bar3, Bar4 } And: Foo2 Class Reference (...) Public Types enum Bar{

Doxygen: Can file members inherit a module grouping if they are in a file that is grouped?

泪湿孤枕 提交于 2019-12-25 02:38:06
问题 Lets assume I have a file, somefile.c. At the top of this file I have /*! * \file somefile.c * \ingroup some_group * * \defgroup some_group Some Awesome Group * \brief Module's description * bla bla bla */ Within the body of this file I have some arbitrary number of functions, typedefs, variables, structs, etc. Right now I am having to go through and put a \ingroup in the documentation block for every single one of these. For the most part I group my modules by file (which I am sure the rest

Doxygen: Can file members inherit a module grouping if they are in a file that is grouped?

人走茶凉 提交于 2019-12-25 02:38:00
问题 Lets assume I have a file, somefile.c. At the top of this file I have /*! * \file somefile.c * \ingroup some_group * * \defgroup some_group Some Awesome Group * \brief Module's description * bla bla bla */ Within the body of this file I have some arbitrary number of functions, typedefs, variables, structs, etc. Right now I am having to go through and put a \ingroup in the documentation block for every single one of these. For the most part I group my modules by file (which I am sure the rest

Doxygen documentation after members - malfunction cause formatting as code fragment?

元气小坏坏 提交于 2019-12-25 02:07:38
问题 I'm running doxygen 1.8.3.1 under SLED 10.4 (linux), and am trying to document a C header file which contains structs similar to the following: /** Test struct definition */ typedef struct { int member_1; /**< Single-line detailed description */ int member_2; /**< Multi-line detailed description. Blah blah blah */ } TEST_S; Doxyfile is the default as generated by doxygen -g , with the only change being that I have edited the INPUT tag to point to my source. Doxygen generates simple memdoc

Doxygen: Why is it ignoring my last Objective-C interface or protocol?

大憨熊 提交于 2019-12-25 01:28:35
问题 I've got a header file that Doxygen lists correctly as one of the files of the project and it will show the source. The Doxygen output shows that the file is being processed. However, the protocol being declared in the file is not being documented in the list of classes. I tried declaring another protocol named Foo immediately before the protocol that's not showing up. The new protocol is processed correctly. I added another one named Bar. It also is processed correctly but still the original

Remove the dot of doxygen's \copydoc?

那年仲夏 提交于 2019-12-24 23:34:14
问题 I have a problem with doxygen's \copydoc . Example file1.h /*! * \file * FileOne */ file2.h /*! * \file * This is similar to the \copydoc file1.h file. */ Documentation always says: This is similar to the. FileOne. file. I don't want this dot (and newline) added. How can i remove it? The reason is, i want it to read a groupname from that file. If it adds a dot, the group is not found. New Example: file1.h /*! * \defgroup FileOne */ /*! * \file * FileOne */ file2.h /*! * \file * \ingroup

Tips for debugging latex errors in Doxygen

故事扮演 提交于 2019-12-24 15:25:12
问题 Right now I get an error message saying: No file _formulas.aux. ... ! Missing $ inserted. ... I've tried looking for and single @f$ tags in the code, but I have not been successful in locating the culprit thus far. How can I go about solving this specific issue? In addition, what are some general tips for debugging latex errors in doxygen? Are there any log files somewhere? 回答1: I use both Doxygen and LaTeX. When compiling formulas, Doxygen will take the contents of your LaTeX equations,

how to get my .cpp file in doxygen documentation too?

对着背影说爱祢 提交于 2019-12-24 14:25:26
问题 I have a c++ project in which I have 2 .hpp files and their .cpp files, I commented all of them but when I run Doxygen I only get .hpp files ? any idea how can i get my source files too ? is possible at least ? 回答1: In DoxyWizard, go to Expert->Input then scroll down to FILE_PATTERNS . Make sure the .cpp extension is listed. If not, insert it into the list. 回答2: Did you try generating the doxygen config file and then see if you'd like to modify anything? doxygen -g "config_file_name" Then run