Lance Shipman | 1 Feb 2011 04:05

Maintaining text on the main.html page

I have several document links and a block of text that I am currently manually adding to the main.html page generated by Doxygen. Is there any way I can automate this addition?

 

Regards,

 

Lance Shipman

------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires 
February 28th, so secure your free ArcSight Logger TODAY! 
http://p.sf.net/sfu/arcsight-sfd2d
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Tom Butterworth | 1 Feb 2011 05:17
Picon
Gravatar

Re: Maintaining text on the main.html page

Put it in a header with


/*! \mainpage Title

Your content

*/


On 1 February 2011 03:05, Lance Shipman <lshipman <at> gte.net> wrote:

I have several document links and a block of text that I am currently manually adding to the main.html page generated by Doxygen. Is there any way I can automate this addition?

 

Regards,

 

Lance Shipman


------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires
February 28th, so secure your free ArcSight Logger TODAY!
http://p.sf.net/sfu/arcsight-sfd2d
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users


------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires 
February 28th, so secure your free ArcSight Logger TODAY! 
http://p.sf.net/sfu/arcsight-sfd2d
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Sajjad | 1 Feb 2011 18:06
Picon

not generating documentation

Helo forum,



I have setup the config file and did some documentation on some my class files to see the output.

I have the frame option enabled so i should see the list of the header files i have edited inside with doxygen block , right?

I have set the INPUT tag and FILE_PATTERNS , RECURSIVE tag as required


Unfortunately i am just getting the index.html with a frame inside and empty contents.


Any hint on the missing stuff?



Regards
Sajjad
------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires 
February 28th, so secure your free ArcSight Logger TODAY! 
http://p.sf.net/sfu/arcsight-sfd2d
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Mathieu Malaterre | 1 Feb 2011 18:40
Picon

GENERATE_MAN / doxygen 1.7.1

Hi all,

  I am trying to understand what changed in my setup doxygen 1.7.1 and
man-db 2.5.7. I used to be able to generate man page using the
GENERATE_MAN option. However today I noticed the output looks odd:

For instance the following:

...
\page gdcmdump dumps a DICOM file, it will display the structure and
values contained in the specified DICOM file.

\section synopsis SYNOPSIS

\verbatim
gdcmdump [options] dcm_file
gdcmdump [options] dcm_directory
\endverbatim
...

leads to:

.TH "gdcmdump" 1 "Tue Feb 1 2011" "Version 2.1.0" "GDCM" \" -*- nroff -*-
.ad l
.nh
.SH NAME
gdcmdump \- .TH "gdcmdump" 1 "Tue Feb 1 2011" "Version 2.1.0" "GDCM"
\" -*- nroff -*-
.ad l
.nh
.SH NAME
gdcmdump \- .SH "SYNOPSIS"
.PP
.PP
.nf

gdcmdump [options] dcm_file
gdcmdump [options] dcm_directory
.fi
.PP

which is displayed as:

NAME
       gdcmdump - .TH "gdcmdump" 1 "Tue Feb 1 2011" "Version 2.1.0" "GDCM"

NAME
       gdcmdump - .SH "SYNOPSIS"

       gdcmdump [options] dcm_file
       gdcmdump [options] dcm_directory

Is anyone else using a recent doxygen version and generating man pages ?

thanks for pointers,

--

-- 
Mathieu

------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires 
February 28th, so secure your free ArcSight Logger TODAY! 
http://p.sf.net/sfu/arcsight-sfd2d
Albert | 1 Feb 2011 19:41
Picon

Re: GENERATE_MAN / doxygen 1.7.1

Mathieu,

Did a quick check on a number of versions.
- 1.6.3 problem didn't occur
- 1.7.1 problem occurred
- 1.7.3 problem still exists
from the contents of the man fie it looks like the endHeader is written twice.

Mathieu, please file a bug report

Best regards,

Albert

On Tue, Feb 1, 2011 at 18:40, Mathieu Malaterre
<mathieu.malaterre <at> gmail.com> wrote:
> Hi all,
>
>  I am trying to understand what changed in my setup doxygen 1.7.1 and
> man-db 2.5.7. I used to be able to generate man page using the
> GENERATE_MAN option. However today I noticed the output looks odd:
>
> For instance the following:
>
> ...
> \page gdcmdump dumps a DICOM file, it will display the structure and
> values contained in the specified DICOM file.
>
> \section synopsis SYNOPSIS
>
> \verbatim
> gdcmdump [options] dcm_file
> gdcmdump [options] dcm_directory
> \endverbatim
> ...
>
> leads to:
>
> .TH "gdcmdump" 1 "Tue Feb 1 2011" "Version 2.1.0" "GDCM" \" -*- nroff -*-
> .ad l
> .nh
> .SH NAME
> gdcmdump \- .TH "gdcmdump" 1 "Tue Feb 1 2011" "Version 2.1.0" "GDCM"
> \" -*- nroff -*-
> .ad l
> .nh
> .SH NAME
> gdcmdump \- .SH "SYNOPSIS"
> .PP
> .PP
> .nf
>
> gdcmdump [options] dcm_file
> gdcmdump [options] dcm_directory
> .fi
> .PP
>
>
> which is displayed as:
>
> NAME
>       gdcmdump - .TH "gdcmdump" 1 "Tue Feb 1 2011" "Version 2.1.0" "GDCM"
>
> NAME
>       gdcmdump - .SH "SYNOPSIS"
>
>       gdcmdump [options] dcm_file
>       gdcmdump [options] dcm_directory
>
>
>
> Is anyone else using a recent doxygen version and generating man pages ?
>
> thanks for pointers,
>
> --
> Mathieu
>
> ------------------------------------------------------------------------------
> Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
> Finally, a world-class log management solution at an even better price-free!
> Download using promo code Free_Logger_4_Dev2Dev. Offer expires
> February 28th, so secure your free ArcSight Logger TODAY!
> http://p.sf.net/sfu/arcsight-sfd2d
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users <at> lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires 
February 28th, so secure your free ArcSight Logger TODAY! 
http://p.sf.net/sfu/arcsight-sfd2d
Mathieu Malaterre | 1 Feb 2011 22:16
Picon

Re: GENERATE_MAN / doxygen 1.7.1

Hi Albert !

  Thanks for the quick answer !
  I did report the issue at:

https://bugzilla.gnome.org/show_bug.cgi?id=641188

  Let me know if you have enough information.

Thanks again !

On Tue, Feb 1, 2011 at 7:41 PM, Albert <albert.tests <at> gmail.com> wrote:
> Mathieu,
>
> Did a quick check on a number of versions.
> - 1.6.3 problem didn't occur
> - 1.7.1 problem occurred
> - 1.7.3 problem still exists
> from the contents of the man fie it looks like the endHeader is written twice.
>
> Mathieu, please file a bug report
>
> Best regards,
>
> Albert
>
> On Tue, Feb 1, 2011 at 18:40, Mathieu Malaterre
> <mathieu.malaterre <at> gmail.com> wrote:
>> Hi all,
>>
>>  I am trying to understand what changed in my setup doxygen 1.7.1 and
>> man-db 2.5.7. I used to be able to generate man page using the
>> GENERATE_MAN option. However today I noticed the output looks odd:
>>
>> For instance the following:
>>
>> ...
>> \page gdcmdump dumps a DICOM file, it will display the structure and
>> values contained in the specified DICOM file.
>>
>> \section synopsis SYNOPSIS
>>
>> \verbatim
>> gdcmdump [options] dcm_file
>> gdcmdump [options] dcm_directory
>> \endverbatim
>> ...
>>
>> leads to:
>>
>> .TH "gdcmdump" 1 "Tue Feb 1 2011" "Version 2.1.0" "GDCM" \" -*- nroff -*-
>> .ad l
>> .nh
>> .SH NAME
>> gdcmdump \- .TH "gdcmdump" 1 "Tue Feb 1 2011" "Version 2.1.0" "GDCM"
>> \" -*- nroff -*-
>> .ad l
>> .nh
>> .SH NAME
>> gdcmdump \- .SH "SYNOPSIS"
>> .PP
>> .PP
>> .nf
>>
>> gdcmdump [options] dcm_file
>> gdcmdump [options] dcm_directory
>> .fi
>> .PP
>>
>>
>> which is displayed as:
>>
>> NAME
>>       gdcmdump - .TH "gdcmdump" 1 "Tue Feb 1 2011" "Version 2.1.0" "GDCM"
>>
>> NAME
>>       gdcmdump - .SH "SYNOPSIS"
>>
>>       gdcmdump [options] dcm_file
>>       gdcmdump [options] dcm_directory
>>
>>
>>
>> Is anyone else using a recent doxygen version and generating man pages ?
>>
>> thanks for pointers,
>>
>> --
>> Mathieu
>>
>> ------------------------------------------------------------------------------
>> Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
>> Finally, a world-class log management solution at an even better price-free!
>> Download using promo code Free_Logger_4_Dev2Dev. Offer expires
>> February 28th, so secure your free ArcSight Logger TODAY!
>> http://p.sf.net/sfu/arcsight-sfd2d
>> _______________________________________________
>> Doxygen-users mailing list
>> Doxygen-users <at> lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>

--

-- 
Mathieu

------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires 
February 28th, so secure your free ArcSight Logger TODAY! 
http://p.sf.net/sfu/arcsight-sfd2d
Udo Weik | 2 Feb 2011 00:21
Picon
Favicon

C++Builder/RAD Studio 2010

Hello,

I'm looking for doxygen-users who use doxgen together
with C++Builder, especially RAD Studio 2010.

Thanks and greetings
Udo

------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires 
February 28th, so secure your free ArcSight Logger TODAY! 
http://p.sf.net/sfu/arcsight-sfd2d
Albert | 2 Feb 2011 07:51
Picon

Re: GENERATE_MAN / doxygen 1.7.1

Hi Mathieu,

For me this would be enough, but if another person has to fix the bug
(most likely) an attachment, to the bug, with a small example file and
stripped Doxyfile would be nice.

Best Regards,

Albert

On Tue, Feb 1, 2011 at 22:16, Mathieu Malaterre
<mathieu.malaterre <at> gmail.com> wrote:
> Hi Albert !
>
>  Thanks for the quick answer !
>  I did report the issue at:
>
> https://bugzilla.gnome.org/show_bug.cgi?id=641188
>
>  Let me know if you have enough information.
>
> Thanks again !
>
> On Tue, Feb 1, 2011 at 7:41 PM, Albert <albert.tests <at> gmail.com> wrote:
>> Mathieu,
>>
>> Did a quick check on a number of versions.
>> - 1.6.3 problem didn't occur
>> - 1.7.1 problem occurred
>> - 1.7.3 problem still exists
>> from the contents of the man fie it looks like the endHeader is written twice.
>>
>> Mathieu, please file a bug report
>>
>> Best regards,
>>
>> Albert
>>
>> On Tue, Feb 1, 2011 at 18:40, Mathieu Malaterre
>> <mathieu.malaterre <at> gmail.com> wrote:
>>> Hi all,
>>>
>>>  I am trying to understand what changed in my setup doxygen 1.7.1 and
>>> man-db 2.5.7. I used to be able to generate man page using the
>>> GENERATE_MAN option. However today I noticed the output looks odd:
>>>
>>> For instance the following:
>>>
>>> ...
>>> \page gdcmdump dumps a DICOM file, it will display the structure and
>>> values contained in the specified DICOM file.
>>>
>>> \section synopsis SYNOPSIS
>>>
>>> \verbatim
>>> gdcmdump [options] dcm_file
>>> gdcmdump [options] dcm_directory
>>> \endverbatim
>>> ...
>>>
>>> leads to:
>>>
>>> .TH "gdcmdump" 1 "Tue Feb 1 2011" "Version 2.1.0" "GDCM" \" -*- nroff -*-
>>> .ad l
>>> .nh
>>> .SH NAME
>>> gdcmdump \- .TH "gdcmdump" 1 "Tue Feb 1 2011" "Version 2.1.0" "GDCM"
>>> \" -*- nroff -*-
>>> .ad l
>>> .nh
>>> .SH NAME
>>> gdcmdump \- .SH "SYNOPSIS"
>>> .PP
>>> .PP
>>> .nf
>>>
>>> gdcmdump [options] dcm_file
>>> gdcmdump [options] dcm_directory
>>> .fi
>>> .PP
>>>
>>>
>>> which is displayed as:
>>>
>>> NAME
>>>       gdcmdump - .TH "gdcmdump" 1 "Tue Feb 1 2011" "Version 2.1.0" "GDCM"
>>>
>>> NAME
>>>       gdcmdump - .SH "SYNOPSIS"
>>>
>>>       gdcmdump [options] dcm_file
>>>       gdcmdump [options] dcm_directory
>>>
>>>
>>>
>>> Is anyone else using a recent doxygen version and generating man pages ?
>>>
>>> thanks for pointers,
>>>
>>> --
>>> Mathieu
>>>
>>> ------------------------------------------------------------------------------
>>> Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
>>> Finally, a world-class log management solution at an even better price-free!
>>> Download using promo code Free_Logger_4_Dev2Dev. Offer expires
>>> February 28th, so secure your free ArcSight Logger TODAY!
>>> http://p.sf.net/sfu/arcsight-sfd2d
>>> _______________________________________________
>>> Doxygen-users mailing list
>>> Doxygen-users <at> lists.sourceforge.net
>>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>>
>>
>
>
>
> --
> Mathieu
>

------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires 
February 28th, so secure your free ArcSight Logger TODAY! 
http://p.sf.net/sfu/arcsight-sfd2d
Victor Jetten | 2 Feb 2011 15:33
Picon

Re: Doxygen warning

Clemens Feige <c.feige <at> osypkamed.com> writes:

> 
> Moshe Kruger wrote:
> > Hello,
> >
> > I am getting this warning quite frequently:
> >
> > Generating /users/gdadmin/PG41/project/src/library/BizData/TAttribute.h:84:
warning:
> explicit link request to 'DataAttribute' could not be resolved
> >
> > The link that Doxygen is meant to create to the element DataAttribute is
being generated.
> >
> > So, I don't understand the meaning. Can anyone enlighten me, please?
> >
> > Moshe Kruger
> > Technical Communicator
> 
> Dear Moshe.
> 
> As Albert already said: Seems you are linking to something which is 
> either undocumented with doxygen or which does not exist. An "explicit 
> link request" is started with "\ref" or "#" (see manual). I guess that 
> somewhere in your doxygen comments you have:
> 
>   \ref DataAttribute  or
>   #DataAttribute
> 
> You said the requested link is genereted. But does it work properly? Is 
> it a dead link?
> 
> Be sure that the "DataAttribute" and the source file in which it appears 
> is documented.
> 
> Clemens
> 
> ------------------------------------------------------------------------------
> Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
> Finally, a world-class log management solution at an even better price-free!
> Download using promo code Free_Logger_4_Dev2Dev. Offer expires 
> February 28th, so secure your free ArcSight Logger TODAY! 
> http://p.sf.net/sfu/arcsight-sfd2d
> 

you get this warning when you are refrencing a function that returns a pointer:
if you have the following doxygen comment

/** bla bla
*  int *foo(void) is a function that bla bla
*/

then the link to foo will not be created, the * causes this warning
if you remove the '*' so you write
/** bla bla
*  int foo(void) is a function that bla bla
*/
a link will be created to foo even if the function itself is still in the code
as 'int *foo(void)'

I don't know what the correct way is to use '*' in a comment

------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires 
February 28th, so secure your free ArcSight Logger TODAY! 
http://p.sf.net/sfu/arcsight-sfd2d
Clemens Feige | 2 Feb 2011 17:20
Favicon

Re: Doxygen warning

Victor Jetten wrote:

> you get this warning when you are refrencing a function that returns a pointer:
> if you have the following doxygen comment
>
> /** bla bla
> *  int *foo(void) is a function that bla bla
> */
>
> then the link to foo will not be created,
[...]

Interesting.

But when referencing to a function I am not aware that one does also 
name the return argument.

"int *foo(void)" is the same as "int* foo(void)" and both should be 
referenced like /** this way foo().*/

Clemens

------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires 
February 28th, so secure your free ArcSight Logger TODAY! 
http://p.sf.net/sfu/arcsight-sfd2d

Gmane