Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Making stable names for doxygen html docs pages

Tags:

doxygen

I need to refer to Doxygen documentation pages. The file names however are not stable as they change after every generation. My idea is to create a symlink to each HTML file created by Doxygen , having a stable and human friendly name. Have anyone tried this?

Actually, it might be very easy just to parse the annotated.html file Doxygen produces. Any documented class shows up there as a line like:

`<tr><td class="indexkey"><a class="el" href="dd/de6/a00548.html">
ImportantClass</a></td>`

The hard problem for me is that I would like to have my file names (i.e. the symlinks) be visible on my server like: http://www.package.com/com.package.my.ImportantClass.html

[Yes, the code is in java]. So the question actually reads: "how to connect a HTML page by Doxygen with the right java class name and its package name.

like image 428
tnorgd Avatar asked Jan 19 '23 06:01

tnorgd


1 Answers

You seem to have SHORT_NAMES enabled, which will indeed produce volatile names. When you set SHORT_NAMES to NO in the configuration file (the default), you will get longer names, but these are stable over multiple runs (i.e. they are based on the name, and for functions also on (a hash of) the parameters.

like image 138
doxygen Avatar answered May 17 '23 09:05

doxygen