doxygen-develop

[Doxygen-develop] Problems generating LaTeX output with Doxygen v1.5.6

[<Mar...@co...>]

Dear Doxygen Users and Developers,

We are using Doxygen for generating html (chm) and latex (pdf) documentation out of our C/C++ source Code.
Along with the header files that contain the doxygen-comments, some additional *.html files are included in the process of generating doxygen documentation. Those extra-html files contain things like Introduction, Examples of Use, Revision History, etc.. They contain doxygen commands like e.g. (and are of course doxygen-conform):
*       @mainpage
*       @section
*       @subpage
*       ...

The generated doxygen html- and latex-output is processed by a self-written perl script to meet our standards in form and content.

Generating the html (chm) output works very fine, no problems occur at all.
However, since we are using the new version 1.5.6 of doxygen, those extra *.html files are ignored by the doxygen process when generating latex output (html still works without problems).

Is this a possible bug in the new version, or are we just overlooking something?

Thanks in advance,
Best Regards,
Marc

___________________________________________

Marc Kurz Bakk.techn.
Customer Support, Documentation Management Assistant

COMNEON electronic technology GmbH & Co. OHG
Freistaedter Strasse 400
A-4040 Linz, Austria

Tel.: +43 (5) 1777 15 - 604
Fax: +43 (5) 1777 15 - 810
E-Mail: mailto:mar...@co...
WEB: http://www.comneon.com

COMNEON - Great Ideas for Small Devices
___________________________________________

Re: [Doxygen-develop] Problems generating LaTeX output with Doxygen v1.5.6

[<Mar...@co...>]

 Hi,

I will try to explain my problem more detailed. Firstly, to avoid misunderstandings I have to clarify a few things:

-> LaTeX processing (the generation of the pdf file out of the LaTeX sources) does NOT show errors, so the LaTeX Syntax is correct.
-> CHM generation works without (semantic and syntactic) problems.
-> Some informtaion is just missing in the LaTeX output, that means:
        - On the one side we have the C/C++ header files, they contain the doxygen comments
        - On the other side we have some (external) files, they are included to the doxygen generation via the INPUT tag.
        - Those files contain also doxygen commands, here is a small example for such a file:

         /**
        @page my_id Detailed Interface Specification

        Here is a list of the modules which are relevant for the Interface:
        <ul>
          <li>Module (@ref ID_OF_MODULE)</li>
        </ul>
     */

        When we generated the documentation with doxygen 1.5.5, both the chm and pdf generation worked without problems, but since we are using the new version 1.5.6, the chm generation still works, but the pdf generation fails. Those external files are not included in the LaTeX sources (so doxygen somehow overlooks them I guess)...



Thanks,

Marc



-----Original Message-----
From: Jan Ruzicka [mailto:jan...@co...]
Sent: Wednesday, September 03, 2008 4:32 PM
To: Kurz Marc (CNAT SWL SEG)
Subject: Re: [Doxygen-develop] Problems generating LaTeX output with Doxygen v1.5.6

Hi Marc

Can you be more specific about the issue with LaTeX?
>From your description I'm not sure what do you consider a problem.
Is LaTeX output missing some information present in HTML version?
Is LaTeX processing showing some error messages?
Please send the clarification to list as I may not be able to help you, but it sounds as interesting problem.
I'm sending this e-mail to you as I don't want to pollute the list.

Thanks
Jan

On 2008/09/03 06:34AM, "Mar...@co..." <Mar...@co...>
wrote:

> Dear Doxygen Users and Developers,
>
> We are using Doxygen for generating html (chm) and latex (pdf)
> documentation out of our C/C++ source Code.
> Along with the header files that contain the doxygen-comments, some
> additional *.html files are included in the process of generating doxygen documentation.
> Those extra-html files contain things like Introduction, Examples of
> Use, Revision History, etc.. They contain doxygen commands like e.g.
> (and are of course doxygen-conform):
> *       @mainpage
> *       @section
> *       @subpage
> *       ...
>
> The generated doxygen html- and latex-output is processed by a
> self-written perl script to meet our standards in form and content.
>
> Generating the html (chm) output works very fine, no problems occur at all.
> However, since we are using the new version 1.5.6 of doxygen, those
> extra *.html files are ignored by the doxygen process when generating
> latex output (html still works without problems).
>
> Is this a possible bug in the new version, or are we just overlooking
> something?
>
> Thanks in advance,
> Best Regards,
> Marc
>
> ___________________________________________
>
> Marc Kurz Bakk.techn.
> Customer Support, Documentation Management Assistant
>
> COMNEON electronic technology GmbH & Co. OHG Freistaedter Strasse 400
> A-4040 Linz, Austria
>
> Tel.: +43 (5) 1777 15 - 604
> Fax: +43 (5) 1777 15 - 810
> E-Mail: mailto:mar...@co...
> WEB: http://www.comneon.com
>
> COMNEON - Great Ideas for Small Devices
> ___________________________________________
>
>
>
> ----------------------------------------------------------------------
> --- This SF.Net email is sponsored by the Moblin Your Move Developer's
> challenge Build the coolest Linux based applications with Moblin SDK &
> win great prizes Grand prize is a trip for two to an Open Source event
> anywhere in the world
> http://moblin-contest.org/redirect.php?banner_id=100&url=/
> _______________________________________________
> Doxygen-develop mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-develop

--
Jan Ruzicka
Software Engineer
jan...@co...
Phone: 240-686-3364

Comtech Mobile Datacom Corp.
20430 Century Boulevard
Germantown, MD 20874
Phone: 240-686-2100
Fax: 240-686-3301

This email and any attachments are intended exclusively for the individuals or entities to which it is addressed. This communication may contain information that is proprietary, privileged or confidential, or otherwise legally exempt from disclosure. If you are not a named addressee, you are not authorized to read, print, retain, copy or disseminate this message or any part of it. If you have received this message in error, please notify the sender immediately by e-mail and delete all copies of the message, any attachments, and any copies thereof from your system.

Re: [Doxygen-develop] Problems generating LaTeX output with Doxygen v1.5.6

[Dimitri V. H. <do...@gm...>]

Hi Marc,

There were some issues with handling pages in the LaTeX output (in  
particular the use of @subpage inside @mainpage)
with version 1.5.6. These should be resolved in the latest snapshot  
found in subversion.
So please try that if possible and let me know if you still see  
problems.

Regards,
   Dimitri

On 5 sep 2008, at 08:14, <Mar...@co...>  
<Mar...@co...> wrote:

>  Hi,
>
> I will try to explain my problem more detailed. Firstly, to avoid  
> misunderstandings I have to clarify a few things:
>
> -> LaTeX processing (the generation of the pdf file out of the LaTeX  
> sources) does NOT show errors, so the LaTeX Syntax is correct.
> -> CHM generation works without (semantic and syntactic) problems.
> -> Some informtaion is just missing in the LaTeX output, that means:
>         - On the one side we have the C/C++ header files, they  
> contain the doxygen comments
>         - On the other side we have some (external) files, they are  
> included to the doxygen generation via the INPUT tag.
>         - Those files contain also doxygen commands, here is a small  
> example for such a file:
>
>
>          /**
>         @page my_id Detailed Interface Specification
>
>         Here is a list of the modules which are relevant for the  
> Interface:
>         <ul>
>           <li>Module (@ref ID_OF_MODULE)</li>
>         </ul>
>      */
>
>         When we generated the documentation with doxygen 1.5.5, both  
> the chm and pdf generation worked without problems, but since we are  
> using the new version 1.5.6, the chm generation still works, but the  
> pdf generation fails. Those external files are not included in the  
> LaTeX sources (so doxygen somehow overlooks them I guess)...
>
>
> Thanks,
>
> Marc
>
>
>
> -----Original Message-----
> From: Jan Ruzicka [mailto:jan...@co...]
> Sent: Wednesday, September 03, 2008 4:32 PM
> To: Kurz Marc (CNAT SWL SEG)
> Subject: Re: [Doxygen-develop] Problems generating LaTeX output with  
> Doxygen v1.5.6
>
> Hi Marc
>
> Can you be more specific about the issue with LaTeX?
> From your description I'm not sure what do you consider a problem.
> Is LaTeX output missing some information present in HTML version?
> Is LaTeX processing showing some error messages?
> Please send the clarification to list as I may not be able to help  
> you, but it sounds as interesting problem.
> I'm sending this e-mail to you as I don't want to pollute the list.
>
> Thanks
> Jan
>
> On 2008/09/03 06:34AM, "Mar...@co..." <Mar...@co...>
> wrote:
>
> > Dear Doxygen Users and Developers,
> >
> > We are using Doxygen for generating html (chm) and latex (pdf)
> > documentation out of our C/C++ source Code.
> > Along with the header files that contain the doxygen-comments, some
> > additional *.html files are included in the process of generating  
> doxygen documentation.
> > Those extra-html files contain things like Introduction, Examples of
> > Use, Revision History, etc.. They contain doxygen commands like e.g.
> > (and are of course doxygen-conform):
> > *       @mainpage
> > *       @section
> > *       @subpage
> > *       ...
> >
> > The generated doxygen html- and latex-output is processed by a
> > self-written perl script to meet our standards in form and content.
> >
> > Generating the html (chm) output works very fine, no problems  
> occur at all.
> > However, since we are using the new version 1.5.6 of doxygen, those
> > extra *.html files are ignored by the doxygen process when  
> generating
> > latex output (html still works without problems).
> >
> > Is this a possible bug in the new version, or are we just  
> overlooking
> > something?
> >
> > Thanks in advance,
> > Best Regards,
> > Marc
> >

Re: [Doxygen-develop] Problems generating LaTeX output with Doxygen v1.5.6

[<Mar...@co...>]

Hi Dimitri,

Thanks for the info, this works. No further problems occur.

BR,
Marc

-----Original Message-----
From: Dimitri Van Heesch [mailto:do...@gm...]
Sent: Friday, September 05, 2008 7:12 PM
To: Kurz Marc (CNAT SWL SEG)
Cc: dox...@li...; jan...@co...
Subject: Re: [Doxygen-develop] Problems generating LaTeX output with Doxygen v1.5.6


Hi Marc,

There were some issues with handling pages in the LaTeX output (in particular the use of @subpage inside @mainpage) with version 1.5.6. These should be resolved in the latest snapshot found in subversion.
So please try that if possible and let me know if you still see problems.

Regards,
   Dimitri

On 5 sep 2008, at 08:14, <Mar...@co...> <Mar...@co...> wrote:

>  Hi,
>
> I will try to explain my problem more detailed. Firstly, to avoid
> misunderstandings I have to clarify a few things:
>
> -> LaTeX processing (the generation of the pdf file out of the LaTeX
> sources) does NOT show errors, so the LaTeX Syntax is correct.
> -> CHM generation works without (semantic and syntactic) problems.
> -> Some informtaion is just missing in the LaTeX output, that means:
>         - On the one side we have the C/C++ header files, they contain
> the doxygen comments
>         - On the other side we have some (external) files, they are
> included to the doxygen generation via the INPUT tag.
>         - Those files contain also doxygen commands, here is a small
> example for such a file:
>
>
>          /**
>         @page my_id Detailed Interface Specification
>
>         Here is a list of the modules which are relevant for the
> Interface:
>         <ul>
>           <li>Module (@ref ID_OF_MODULE)</li>
>         </ul>
>      */
>
>         When we generated the documentation with doxygen 1.5.5, both
> the chm and pdf generation worked without problems, but since we are
> using the new version 1.5.6, the chm generation still works, but the
> pdf generation fails. Those external files are not included in the
> LaTeX sources (so doxygen somehow overlooks them I guess)...
>
>
> Thanks,
>
> Marc
>
>
>
> -----Original Message-----
> From: Jan Ruzicka [mailto:jan...@co...]
> Sent: Wednesday, September 03, 2008 4:32 PM
> To: Kurz Marc (CNAT SWL SEG)
> Subject: Re: [Doxygen-develop] Problems generating LaTeX output with
> Doxygen v1.5.6
>
> Hi Marc
>
> Can you be more specific about the issue with LaTeX?
> From your description I'm not sure what do you consider a problem.
> Is LaTeX output missing some information present in HTML version?
> Is LaTeX processing showing some error messages?
> Please send the clarification to list as I may not be able to help
> you, but it sounds as interesting problem.
> I'm sending this e-mail to you as I don't want to pollute the list.
>
> Thanks
> Jan
>
> On 2008/09/03 06:34AM, "Mar...@co..." <Mar...@co...>
> wrote:
>
> > Dear Doxygen Users and Developers,
> >
> > We are using Doxygen for generating html (chm) and latex (pdf)
> > documentation out of our C/C++ source Code.
> > Along with the header files that contain the doxygen-comments, some
> > additional *.html files are included in the process of generating
> doxygen documentation.
> > Those extra-html files contain things like Introduction, Examples of
> > Use, Revision History, etc.. They contain doxygen commands like e.g.
> > (and are of course doxygen-conform):
> > *       @mainpage
> > *       @section
> > *       @subpage
> > *       ...
> >
> > The generated doxygen html- and latex-output is processed by a
> > self-written perl script to meet our standards in form and content.
> >
> > Generating the html (chm) output works very fine, no problems
> occur at all.
> > However, since we are using the new version 1.5.6 of doxygen, those
> > extra *.html files are ignored by the doxygen process when
> generating
> > latex output (html still works without problems).
> >
> > Is this a possible bug in the new version, or are we just
> overlooking
> > something?
> >
> > Thanks in advance,
> > Best Regards,
> > Marc
> >

Re: [Doxygen-develop] Problems generating LaTeX output with Doxygen v1.5.6

[<Mar...@co...>]

Hi Dimitri,

Is it possible that there are still some open issues concerning this problem?

It seems that the generated latex (pdf) structure of content is different to the generated html (chm) content.
We are using the tags @page, @subpage, @section, @mainpage in our external documents, and the structure and order of the singular sections differs from the chm to the pdf, whereas the pdf output looks very damaged.

Thanks in advance,
Marc

-----Original Message-----
From: Dimitri Van Heesch [mailto:do...@gm...]
Sent: Friday, September 05, 2008 7:12 PM
To: Kurz Marc (CNAT SWL SEG)
Cc: dox...@li...; jan...@co...
Subject: Re: [Doxygen-develop] Problems generating LaTeX output with Doxygen v1.5.6


Hi Marc,

There were some issues with handling pages in the LaTeX output (in particular the use of @subpage inside @mainpage) with version 1.5.6. These should be resolved in the latest snapshot found in subversion.
So please try that if possible and let me know if you still see problems.

Regards,
   Dimitri

On 5 sep 2008, at 08:14, <Mar...@co...> <Mar...@co...> wrote:

>  Hi,
>
> I will try to explain my problem more detailed. Firstly, to avoid
> misunderstandings I have to clarify a few things:
>
> -> LaTeX processing (the generation of the pdf file out of the LaTeX
> sources) does NOT show errors, so the LaTeX Syntax is correct.
> -> CHM generation works without (semantic and syntactic) problems.
> -> Some informtaion is just missing in the LaTeX output, that means:
>         - On the one side we have the C/C++ header files, they contain
> the doxygen comments
>         - On the other side we have some (external) files, they are
> included to the doxygen generation via the INPUT tag.
>         - Those files contain also doxygen commands, here is a small
> example for such a file:
>
>
>          /**
>         @page my_id Detailed Interface Specification
>
>         Here is a list of the modules which are relevant for the
> Interface:
>         <ul>
>           <li>Module (@ref ID_OF_MODULE)</li>
>         </ul>
>      */
>
>         When we generated the documentation with doxygen 1.5.5, both
> the chm and pdf generation worked without problems, but since we are
> using the new version 1.5.6, the chm generation still works, but the
> pdf generation fails. Those external files are not included in the
> LaTeX sources (so doxygen somehow overlooks them I guess)...
>
>
> Thanks,
>
> Marc
>
>
>
> -----Original Message-----
> From: Jan Ruzicka [mailto:jan...@co...]
> Sent: Wednesday, September 03, 2008 4:32 PM
> To: Kurz Marc (CNAT SWL SEG)
> Subject: Re: [Doxygen-develop] Problems generating LaTeX output with
> Doxygen v1.5.6
>
> Hi Marc
>
> Can you be more specific about the issue with LaTeX?
> From your description I'm not sure what do you consider a problem.
> Is LaTeX output missing some information present in HTML version?
> Is LaTeX processing showing some error messages?
> Please send the clarification to list as I may not be able to help
> you, but it sounds as interesting problem.
> I'm sending this e-mail to you as I don't want to pollute the list.
>
> Thanks
> Jan
>
> On 2008/09/03 06:34AM, "Mar...@co..." <Mar...@co...>
> wrote:
>
> > Dear Doxygen Users and Developers,
> >
> > We are using Doxygen for generating html (chm) and latex (pdf)
> > documentation out of our C/C++ source Code.
> > Along with the header files that contain the doxygen-comments, some
> > additional *.html files are included in the process of generating
> doxygen documentation.
> > Those extra-html files contain things like Introduction, Examples of
> > Use, Revision History, etc.. They contain doxygen commands like e.g.
> > (and are of course doxygen-conform):
> > *       @mainpage
> > *       @section
> > *       @subpage
> > *       ...
> >
> > The generated doxygen html- and latex-output is processed by a
> > self-written perl script to meet our standards in form and content.
> >
> > Generating the html (chm) output works very fine, no problems
> occur at all.
> > However, since we are using the new version 1.5.6 of doxygen, those
> > extra *.html files are ignored by the doxygen process when
> generating
> > latex output (html still works without problems).
> >
> > Is this a possible bug in the new version, or are we just
> overlooking
> > something?
> >
> > Thanks in advance,
> > Best Regards,
> > Marc
> >

[Doxygen-develop] @ingroup tag for pages

[<Eug...@CO...>]

dear doxygen users and developers,

for structuring modules in doxygen, you can use e.g. the @defgroup and @ingroup tags to define a hierarchie. this works "bottom up", meaning that in a @defgroup block, an @ingroup tag defines the parent module.

is there something similar for pages?

for pages, you can define a structure only "top down".

example:

/**
@page page_1 Page 1

...
@subpage page_1_1
*/

/**
@page page_1_1 Page 1.1
...
*/

what we would need for our purpose is something like at "@inpage" tag:

/**
@page page_1 Page 1
...
*/

/**
@page page_1_1 Page 1.1
@inpage page_1
...
*/

would this make sense to include into a future release?

best regards,
Eugen

Re: [Doxygen-develop] @ingroup tag for pages

[<Eck...@t-...>]

Hello Mr Kimmerstorfer.

I'm missing also this inpage-command. But I've found an possibility to
simulate this.


Try the following:


/**
@page page_1 Page 1



First Part-Content of page 1

...
*/

/**

@page page_1 Page 1

@subpage page_1_1 

@page page_1_1 Page 1.1


Content of page 1.1

...
*/



**

@page page_1 Page 1

@subpage page_1_2 

@page page_1_2 Page 1.2


Content of page 1.2

...
*/



Using the page-command more than once for the same page has not the
effect that the result of the first commands will be overwritten. It has
the effect that the new content will be added to the old.  If you only
use the subpage-command between the page-command of the containig page
and the page-commang of the contained page only the refference to the
contained page will be added to the containing page. The order of the
part-contents of the containing page depends on the order of the
commmands doxygen will find.

Perhaps it may be a good idea to use an alias to create an inpage
command 
 

I hope this will help you.

Best regards,
                          Eckard Klotz





-----Original Message-----
Date: Thu, 11 Sep 2008 09:33:37 +0200
Subject: [Doxygen-develop]  @ingroup tag for pages
From: <Eug...@CO...>
To: <do...@gm...>, <dox...@li...>,
<jan...@co...>

dear doxygen users and developers,

for structuring modules in doxygen, you can use e.g. the @defgroup and
@ingroup tags to define a hierarchie. this works "bottom up", meaning
that in a @defgroup block, an @ingroup tag defines the parent module.

is there something similar for pages?

for pages, you can define a structure only "top down".

example:

/**
@page page_1 Page 1

...
@subpage page_1_1
*/

/**
@page page_1_1 Page 1.1
...
*/

what we would need for our purpose is something like at "@inpage" tag:

/**
@page page_1 Page 1
...
*/

/**
@page page_1_1 Page 1.1
@inpage page_1
...
*/

would this make sense to include into a future release?

best regards,
Eugen

-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's
challenge
Build the coolest Linux based applications with Moblin SDK & win great
prizes
Grand prize is a trip for two to an Open Source event anywhere in the
world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Doxygen-develop mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-develop