paamayim_nekudotayim | 6 Aug 2012 07:37
Picon

Doxygen 1.8.1.2 HTML Help generation


Hello Doxygen-Community!
I'm currently helping my company to migrate from the old doxygen 1.7.x to
the current version 1.8.1.2 .
We use doxygen to generate a Microsoft HTML Help file from our source files
for API documentation and additionaly we have some non code .doxy files
which describe a small tutorial + introduction page.
When using doxygen 1.7.x the HTML Help file is generated perfectly but
1.8.1.2 scrambles the navigation tree of the HTML Help file. The navigation
tree is generated correctly for the html pages auto generated from source
files (we use \group and \ingroup to describe dependencies in the source
files), only for the tutorial + introduction pages (split into multiple
.doxy files, concatinated by /page and /subpage commands) the html help
navigation tree contains dead links and the subpages are not placed
correctly. 
After some experimentation i discovered that Doxygen 1.8.1.2 generates the
HTML Help navigation tree directly from the Doxygen layout XML file's
<navindex> tag (1.7.x generated it from the \page-\subpage hirachy), but
even if i create a link manually by using a <tab type="user" ... /> and
putting a  <at> ref to the wanted page into the href attribute, the resulting
link in the HTML Help navigation tree is dead.
Since the linking of the HMTL pages is working i inspected the HTML Help
source files and discovered that the hhc file structure is not correct as
the wanted pages get referenced incorrectly by, e.g.
"!tutorialfile.html.html" instead of "tutorialfile.html" . 

I am not sure if this is a doxygen bug, because while migrating our
documentation system i discovered that doxygen 1.8.x is much more sensive to
command syntax than 1.7.x is, so i'm not sure if this is caused by any small
mistakes in the .doxy files (this are the same files that 1.7.x generates a
(Continue reading)

Dimitri van Heesch | 6 Aug 2012 11:18
Picon
Gravatar

Re: Doxygen 1.8.1.2 HTML Help generation

Hi Tobias,

On Aug 6, 2012, at 7:37 , paamayim_nekudotayim <tobias.appl <at> gmail.com> wrote:

> 
> Hello Doxygen-Community!
> I'm currently helping my company to migrate from the old doxygen 1.7.x to
> the current version 1.8.1.2 .
> We use doxygen to generate a Microsoft HTML Help file from our source files
> for API documentation and additionaly we have some non code .doxy files
> which describe a small tutorial + introduction page.
> When using doxygen 1.7.x the HTML Help file is generated perfectly but
> 1.8.1.2 scrambles the navigation tree of the HTML Help file. The navigation
> tree is generated correctly for the html pages auto generated from source
> files (we use \group and \ingroup to describe dependencies in the source
> files), only for the tutorial + introduction pages (split into multiple
> .doxy files, concatinated by /page and /subpage commands) the html help
> navigation tree contains dead links and the subpages are not placed
> correctly. 
> After some experimentation i discovered that Doxygen 1.8.1.2 generates the
> HTML Help navigation tree directly from the Doxygen layout XML file's
> <navindex> tag (1.7.x generated it from the \page-\subpage hirachy), but
> even if i create a link manually by using a <tab type="user" ... /> and
> putting a  <at> ref to the wanted page into the href attribute, the resulting
> link in the HTML Help navigation tree is dead.
> Since the linking of the HMTL pages is working i inspected the HTML Help
> source files and discovered that the hhc file structure is not correct as
> the wanted pages get referenced incorrectly by, e.g.
> "!tutorialfile.html.html" instead of "tutorialfile.html" . 
> 
(Continue reading)

paamayim_nekudotayim | 6 Aug 2012 11:35
Picon

Re: Doxygen 1.8.1.2 HTML Help generation


Thanks for the reply!

Dimitri van Heesch-2 wrote:
> 
> 
> I think you found a bug in doxygen. Can you file a bug report for it?
> 
> ...
> 

I will file a bug report for i found some more bugs regarding the HTML Help
file generator.

-Tobias
--

-- 
View this message in context: http://old.nabble.com/Doxygen-1.8.1.2-HTML-Help-generation-tp34249562p34260287.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
paamayim_nekudotayim | 6 Aug 2012 11:48
Picon

Re: Doxygen 1.8.1.2 HTML Help generation


What exactly is the bug here ?
I'm sure that the incorrect links are a bug, but is it also a bug that the
HTML Help generation tree is generated from the layout.xml <navindex> tag ? 

Regards,
Tobias
--

-- 
View this message in context: http://old.nabble.com/Doxygen-1.8.1.2-HTML-Help-generation-tp34249562p34260350.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
Dimitri van Heesch | 6 Aug 2012 12:05
Picon
Gravatar

Re: Doxygen 1.8.1.2 HTML Help generation


On Aug 6, 2012, at 11:48 , paamayim_nekudotayim <tobias.appl <at> gmail.com> wrote:

> 
> What exactly is the bug here ?
> I'm sure that the incorrect links are a bug,

Indeed.

> but is it also a bug that the
> HTML Help generation tree is generated from the layout.xml <navindex> tag ? 

No, all navigation trees (HTML tree view, HTML Help, Qt Help, XCode docsets, Eclipse help) should 
have the same structure and should be configurable via the layout.xml file.

Regards,
  Dimitri

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/

Gmane