17

I am automating documentation generation using Doxygen. How can I specify a favicon (URL icon) for the output?

Andrew Ring
  • 3,185
  • 1
  • 23
  • 28
  • 1
    Not really an answer. As far as I know there is no way to do this at the moment. I looked at he wiki page and saw that the method should work so incorporated it in a test page. It worked for Firefox and OPera but not for IE9 and Google Chrome. Any ideas how it could work there? – albert Aug 16 '13 at 17:13
  • Did you add that manually to the output from Doxygen, or did you find a way to have Doxygen output that tag automatically? – Andrew Ring Aug 17 '13 at 18:20

1 Answers1

28

In doxygen one has the possibility to define his own HTML header file, best based on the default HTML header file.

To obtain the default HTML header file, syntax:

doxygen -w html headerFile footerFile styleSheetFile [configFile]

in the headerFile insert in the head part a line like:

<link rel="icon" href="$relpath^my_icon.ico" type="image/x-icon" />

Note: that the $relpath^ part is necessary especially in case of CREATE_SUBDIRS is set.

Furthermore in the configuration file (Doxyfile) you have to set:

HTML_HEADER            = headerFile
HTML_EXTRA_FILES       += my_icon.ico

Of course the standard restrictions regarding favicons still apply (regarding support by browsers etc.).

albert
  • 8,285
  • 3
  • 19
  • 32