Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to add an external resource (pdf file) in my doxygen documentation

Tags:

doxygen

I generate a doxygen documentation. In one of my "page" I have a link to a pdf file:

<a href="../documents/xxx.pdf" target="_blank"><b>Overview</b></a>

This file is in my project in another directory. The documentation ends up in folder called "html".

How do I tell doxygen to copy the pdf file into html ?

like image 292
Barth Avatar asked Sep 16 '11 09:09

Barth


People also ask

How do I upload a file to Doxygen?

Just list your custom files in the INPUT macro in your doxyfile. You can choose whatever name you find appropriate. Format is text with Doxygen tags.

How do I exclude a file in Doxygen?

How can I make doxygen ignore some code fragment? The new and easiest way is to add one comment block with a \cond command at the start and one comment block with a \endcond command at the end of the piece of code that should be ignored. This should be within the same file of course.

What is Doxy file?

File created by Doxygen, a documentation system for programming languages such as C++, Java, Python, and PHP; contains text and Doxygen markup tags, which include references to source code files and specifications for generating documents.


1 Answers

There is a doxygen configuration option HTML_EXTRA_FILES that allows extra files to be copied to the root of the html documentation. You should be able to specify the following to copy the file:

HTML_EXTRA_FILES = ../documents/xxx.pdf

This will place xxx.pdf in the root of your HTML documentation, so you will likely need to change your link to:

<a href="xxx.pdf" target="_blank"><b>Overview</b></a>
like image 95
DRH Avatar answered Dec 05 '22 08:12

DRH