Doxygen shows at the end of each html file the text "The document for this ... was generated from the following file..."
Is it possible to remove this text by using an option in the doxyfile?
With the aid of the configuration parameter SHOW_USED_FILES it is possible to disable the sentence ""The documentation for this...".
From the documentation:
SHOW_USED_FILES
Set the SHOW_USED_FILES tag to NO to disable the list
of files generated at the bottom of the documentation of classes and
structs. If set to YES, the list will mention the files that were used
to generate the documentation.
The default value is: YES.
Related
I am trying to use tableofcontents command from Doxygen Doc.
To me \tableofcontents['{'[option[:level]][,option[:level]]*'}'] seems very cryptic.
Could you give an example of how to pass options and levels?
From the doxygen documentation:
24.111 \tableofcontents['{'[option[:level]][,option[:level]]'}']
Creates a table of contents at the top of a page, listing all sections and subsections in the page. The option can
be HTML or LaTeX or XML or DocBook. When a level is specified this means the maximum nesting level that
is shown. The value of level should be in the range 1..5, values outside this range are considered to be 5. In
case no level is specified level is set to 5 (show all) In case no option. is specified \tableofcontents
acts as if just the option HTML and XML was specified. In case of multiple \tableofcontents commands
in a page the option(s)
See also the beginning of the chapter "Special Commands" where a small description is of some of the used symbols.
So e.g.:
\tableofcontents
\tableofcontents{HTML}
\tableofcontents{HTML:3}
\tableofcontents{HTML:2,LaTex:3}
If I write some URL in source code comments like:
/**
* Here is an inline link [test](http://www.test.com).
* More information:
* test
*/
I enabled GENERATE_XML in Doxygen. This is what it generates:
<para>Here is an inline link [test](<ulink url="http://www.test.com">http://www.test.com</ulink>).
More information:
<ulink url="http://www.test.com">test</ulink> </para>
After converting the tags, I can create a Markdown content like:
Here is an inline link [test](http://www.test.com).
More information:
test
Note that the Markdown link [test](http://www.test.com) is polluted, which will break the link after I feed this into another Markdown processor. I need this as I want to write some markdown in comments, and extract it to some structured data formats for other tools to processing the markdown. I have disabled MARKDOWN_SUPPORT in Doxygen.
I have tried disable AUTOLINK_SUPPORT in doxyfile, but it can only disable internal type link to class/method/...
Solution for the mentioned problem, auto linking a web address, is to use [test](%http://www.test.com). By means of the % sign the (automatic) linking is suppressed.
In the documentation, paragraph "Step 3: Documenting the sources":
Links are created for words corresponding to documented classes (unless the word is preceded by a %; then the word will not be linked and the % sign is removed).
Note: in the above quote the wording is only for classes but it does work on other places as well. The same "problem" occurs in other places:
Description of AUTOLINK_SUPPORT
FAQ Doxygen automatically generates a link to the class MyClass somewhere
in the running text. How do I prevent that at a certain place?
Paragraph Links to classes
Paragraph "\%"
To distinguish this question from Doxygen: Adding a custom link under the "Related Pages" section which has an accepted answer that is not a real answer to the question, I specifically add prewritten to the question.
What I want:
Write one document tex file (without preamble, since this file will be \input-ed into a full document)
Import the document into Doxygen's HTML output.
Using Doxygen to produce tex file will probably not work, since it does too much layout work [This holds for its HTML output too like empty table rows 2015]. If Doxygen takes some other input that can easily be transformed into LaTeX, that will do.
You can easily add an already existing Latex file to your doxygen documentation using \latexonly\input{yourfile}\endlatexonly.
I would assume you put it e.g. under a doxygen \page.
I want to include an external dot diagram to my doxygen documentation -- in \mainpage My Personal Index Page. How would I go about it?
Would I include it as an attached png or can I have doxygen generate the diagram itself?
You can use the \dotfile command to reference a dot file from inside a doxygen comment block.
Doxygen will run dot and include the resulting image in the generated documentation.
See http://www.doxygen.nl/manual/commands.html#cmddotfile for more info.
Is there a way to suppress Doxygen from giving "not documented" warnings on particular files? My project has several automatically generated code headers that cause it to throw hundreds or thousands of errors that make it difficult to sift through.
You could use suppression tags in the generated files:
//! #cond Doxygen_Suppress
code
//! #endcond
You don't need the "Doxygen_Suppress" in there, but I like it for clarity.
There are more options in the doxygen FAQ
EDIT:
Ok, I should have done my due diligence, I have an answer that is more appropriate to your situation. I believe you need to exclude the files entirely. Add this to your doxygen file:
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE = abc.cpp \
abc.h
The irony is I have had this problem and solved it, then forgot all about it... Brain must be full again.
I pulled this information from the doxygen Configuration page, but if you are lazy like me, just use the gui tool (doxywizard) and go through and select all the things you want and have it save the doxyfile for you.
There's a config option for that, as stated in documentation
WARN_IF_UNDOCUMENTED
If WARN_IF_UNDOCUMENTED is set to YES, then
doxygen will generate warnings for undocumented members. If
EXTRACT_ALL is set to YES then this flag will automatically be
disabled.
In my automatically generated headers I just add the doxygen documentation into the auto-generation routine.
This means that nothing is left undocumented.
If anyone is using Eclipse, I definitely suggest to open your file (*.doxyfile) with a text editor (note that eclipse open it with "Doxyfile Editor" by default).
So:
right click on your doxyfile and select "open-with"->"text editor"
search for WARN_IF_UNDOCUMENTED (setted 'YES' by default)
change in 'NO'.
Adding tags
//! #cond Doxygen_Suppress
code
//! #endcond
if you have many classes should be boring and hard.
Documentation for other configuration's options are available here.