Doxygen user discussions and queries

Philippe Jacobs | 2 Jan 2006 16:39

Naming discrepancy between "group" and "module"

Hello,

This is a small issue, but still.

There seems to be a discrepancy in all the documentation about this naming: we use \ingroup, \defgroup,
\addtogroup, ... and even in the list of groups, all group names are preceded by the word "group".  But in the
documentation the titles always mention "Modules".

Already several people have asked me why the titles (of the page or a list of groups) is "Modules" and not "Groups".
Is there a reason for this?

Thanks,
Philippe

This e-mail communication contains information that is confidential and may also be privileged. It is
intended for the exclusive use of the addressees. If you are not the person or organisation to whom it is
addressed, you must not copy, distribute, or take any action in reliance upon it. If you have received this
communication in error, please notify Septentrio nv immediately [telephone: +32 [0]16 300 800].
Septentrio nv will not accept liability for contractual commitments made by individuals employed by
this company outside the scope of our business.

headers

Nadine Ngo | 3 Jan 2006 00:19

Questions on Module List

Hello,

I have two questions to ask and thanks very much for any help.

I am currently using Doxygen 1.4.5.

1) Can we provide descriptions information to the Module list?

2) Is there a way to sort the Module list?

Thanks again and regards.

__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com

headers

Nadine Ngo | 3 Jan 2006 00:34

Questions on Module List.

Hello,

I have two questions to ask and thanks very much for any help.

I am currently using Doxygen 1.4.5.

1) Can we provide descriptions information to the Module list?

2) Is there a way to sort the Module list?

Thanks again and regards.

__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com

headers

Ricky Marek | 3 Jan 2006 11:02

Is somebody using KingsTools for doxygen?

Hello,

KingsTools(http://www.codeproject.com/macro/kingstools.asp) is an Add-On
for Visual Studio that allows you to add doxygen comments, create the
doxygen configuration file and run it from Microsoft Visual Studio.

In the past I had problems in tailoring the latest versions of Doxygen
to it.

Does somebody use this tool for making Doxygen friendly with Visual
Studio?

Thanks in advance and have a successful new year

--- Ricky Marek

********************** Legal Disclaimer ****************************
"This email may contain confidential and privileged material for the sole use of the intended recipient. 
Any unauthorized review, use or distribution by others is strictly prohibited.  If you have received the
message in error, please advise the sender by reply email and delete the message. Thank you."
**********************************************************************

-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems?  Stop!  Download the new AJAX search engine that makes
searching your log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
http://ads.osdn.com/?ad_idv37&alloc_id865&op=click

headers

Friedrich, Lars | 3 Jan 2006 11:38

RE: Is somebody using KingsTools for doxygen?

> KingsTools(http://www.codeproject.com/macro/kingstools.asp)
> is an Add-On for Visual Studio that allows you to add doxygen
comments,
> create the doxygen configuration file and run it from Microsoft Visual
Studio.

> Does somebody use this tool for making Doxygen friendly with Visual
> Studio?

Visual Studio (at least since version 2003, maybe earlier) is able to
generate
XML comments according to ECMA-334 standard (aka C# comments). Doxygen
is able
to understand XML comments according to ECMA-334. So I would say Visual
Studio
is already Doxygen-friendly (or vice versa). I don't quite see your
problem.

Best regards,
Lars Friedrich

-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems?  Stop!  Download the new AJAX search engine that makes
searching your log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
http://ads.osdn.com/?ad_idv37&alloc_id865&op=click

headers

Dimitri van Heesch | 3 Jan 2006 12:58

Re: Naming discrepancy between "group" and "module"

On 1/2/06, Philippe Jacobs <p.jacobs <at> septentrio.com> wrote:

Hello,

This is a small issue, but still.

There seems to be a discrepancy in all the documentation about this naming: we use \ingroup, \defgroup, \addtogroup, ... and even in the list of groups, all group names are preceded by the word "group". But in the documentation the titles always mention "Modules".

Already several people have asked me why the titles (of the page or a list of groups) is "Modules" and not "Groups".
Is there a reason for this?

The (historic) reason for this is that the Qt documentation tool, whose commands and output I have (once) tried to mimic, was also doing this.

Regards,
Dimitri

headers

Dimitri van Heesch | 3 Jan 2006 13:01

Re: <at> n in Indexes for anon enums

On 12/22/05, E. Gail <E.Gail <at> portalplayer.com> wrote:

I can't figure out the <at> n index entries that show up in my
doxygen-generated CHMs. Clearly <at> 0 is a sequentially generated heading
for the anonymous enums that follow. However, that heading is confusing
to index users. It is meaningless. In addition, when a user sees in the
CHM several of these category headings, there's no meaning conveyed as
to what each one is. Doxygen generates over 14,000 files for my project,
so I have many anonymous enum entries in the final index. One part of
the index looks like this:
         <at> 1
                BootPartition
                Debug.h
                MMdriver
         <at> 13
                Format
                FxUsb
         <at> 2
                BootLoader
                USBc
So you see they aren't even sorting numerically in the index. This is
confusing! I have not been able to modify the HHK file and regenerate a
CHM, because the modifications get wiped out by HHC and restored to the
original settings.

Can someone help? Can doxygen at least call these "Anonymous enums" in
the index? (Instead of <at> ). That conveys meaning. In addition, can we
have ONE heading for all these enums? Instead of some random number of
headings with no information as to why <at> 0 group contains those enums
versus <at> 1 group containing other enums, and so on.

The <at> 's are internal names used by doxygen. They should not appear in the output. Please file a bug for this which includes a small example (source+config file) that allows me to reproduce the problem.

Regards,
Dimitri

headers

Ricky Marek | 3 Jan 2006 16:20

RE: Is somebody using KingsTools for doxygen?

Hello Lars,

Thanks for your fast response.

The problem is not how to create the comments and let Doxygen work with
them, but with the integration the KingsTools has with Doxygen, The good
thing about the KingsTools is that with a single keystroke, you have all
your project being doxygenized ( run doxygen only on the files defined
in your Visual Studio Project, using the corresponding settings and get
the resulting HTML files or CHM file ).

Using doxygen usually has three steps:
- Create the configuration file for doxygen,
- Insert the proper comments in your code, and
- Run Doxygen on all the relevant files of your project.

Now, 
- if you add/remove files from your projects, you need to synchronize
the changes in the way you run doxygen. (makefiles, scripts, etc..)
- if you change settings in your projects, you may need to synchronize
the changes with your doxygen configuration file.

The above two jobs (or last two items from the three steps above) are
done by the KingsTools when integrated with Visual Studio (VC++ .NET
2003 in my case).

My question was if somebody is using the KingsTools with newer versions
of Doxygen.

The KingsTools use Doxygen 1.3.1 (really old) version with an
appropriated help compiler from Microsoft to create the CHM file. 
A problem occurs when you change the to a newer version of doxygen that
causes the tool to crash, it seems that the html help compiler(hhc.exe)
supplied with KingsTools does not like the html files produced by the
new Doxigen. 

Have a successful year :)

--- Ricky.

-----Original Message-----
From: doxygen-users-admin <at> lists.sourceforge.net
[mailto:doxygen-users-admin <at> lists.sourceforge.net] On Behalf Of
Friedrich, Lars
Sent: Tuesday, January 03, 2006 12:38 PM
To: doxygen-users <at> lists.sourceforge.net
Subject: RE: [Doxygen-users] Is somebody using KingsTools for doxygen?

> KingsTools(http://www.codeproject.com/macro/kingstools.asp)
> is an Add-On for Visual Studio that allows you to add doxygen
comments,
> create the doxygen configuration file and run it from Microsoft Visual
Studio.

> Does somebody use this tool for making Doxygen friendly with Visual 
> Studio?

Visual Studio (at least since version 2003, maybe earlier) is able to
generate XML comments according to ECMA-334 standard (aka C# comments).
Doxygen is able to understand XML comments according to ECMA-334. So I
would say Visual Studio is already Doxygen-friendly (or vice versa). I
don't quite see your problem.

Best regards,
Lars Friedrich

-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log
files for problems?  Stop!  Download the new AJAX search engine that
makes searching your log files as easy as surfing the  web.  DOWNLOAD
SPLUNK!
http://ads.osdn.com/?ad_idv37&alloc_id865&op=ick
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

********************** Legal Disclaimer ****************************
"This email may contain confidential and privileged material for the sole use of the intended recipient. 
Any unauthorized review, use or distribution by others is strictly prohibited.  If you have received the
message in error, please advise the sender by reply email and delete the message. Thank you."
**********************************************************************

-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems?  Stop!  Download the new AJAX search engine that makes
searching your log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
http://ads.osdn.com/?ad_idv37&alloc_id865&op=click

headers

Thomas Hemmer | 3 Jan 2006 16:38

AW: Is somebody using KingsTools for doxygen?

Ricky,

wouldn't it be worth a try to replace the help compiler supplied with KingsTools
by another one freshly downloaded from M$?
I have been using doxygen version 1.4.4 together with HTML help workshop version
4.74.8702.0 for a long time without any trouble.
Ok, I am not using KingsTools, but IMHO this should not make the difference as
it sounds like doxygen's output confused HHC in your case.

Best regards,

Thomas

Thomas Hemmer
GO Engineering GmbH
Stolzenbergstraße 13/IV
76532 Baden-Baden

Tel:  +49 7221 50436-51
Fax:  +49 7221 50436-36

email: themmer <at> go-engineering.de
web:   www.go-engineering.de

-----Ursprüngliche Nachricht-----
Von: doxygen-users-admin <at> lists.sourceforge.net
[mailto:doxygen-users-admin <at> lists.sourceforge.net] Im Auftrag von Ricky Marek
Gesendet: Dienstag, 3. Januar 2006 16:21
An: doxygen-users <at> lists.sourceforge.net
Cc: Friedrich, Lars
Betreff: RE: [Doxygen-users] Is somebody using KingsTools for doxygen?

Hello Lars,

Thanks for your fast response.

The problem is not how to create the comments and let Doxygen work with them,
but with the integration the KingsTools has with Doxygen, The good thing about
the KingsTools is that with a single keystroke, you have all your project being
doxygenized ( run doxygen only on the files defined in your Visual Studio
Project, using the corresponding settings and get the resulting HTML files or
CHM file ).

Using doxygen usually has three steps:
- Create the configuration file for doxygen,
- Insert the proper comments in your code, and
- Run Doxygen on all the relevant files of your project.

Now,
- if you add/remove files from your projects, you need to synchronize the
changes in the way you run doxygen. (makefiles, scripts, etc..)
- if you change settings in your projects, you may need to synchronize the
changes with your doxygen configuration file.

The above two jobs (or last two items from the three steps above) are done by
the KingsTools when integrated with Visual Studio (VC++ .NET
2003 in my case).

My question was if somebody is using the KingsTools with newer versions of
Doxygen.

The KingsTools use Doxygen 1.3.1 (really old) version with an appropriated help
compiler from Microsoft to create the CHM file.
A problem occurs when you change the to a newer version of doxygen that causes
the tool to crash, it seems that the html help compiler(hhc.exe) supplied with
KingsTools does not like the html files produced by the new Doxigen.

Have a successful year :)

--- Ricky.

-----Original Message-----
From: doxygen-users-admin <at> lists.sourceforge.net
[mailto:doxygen-users-admin <at> lists.sourceforge.net] On Behalf Of Friedrich, Lars
Sent: Tuesday, January 03, 2006 12:38 PM
To: doxygen-users <at> lists.sourceforge.net
Subject: RE: [Doxygen-users] Is somebody using KingsTools for doxygen?

> KingsTools(http://www.codeproject.com/macro/kingstools.asp)
> is an Add-On for Visual Studio that allows you to add doxygen
comments,
> create the doxygen configuration file and run it from Microsoft Visual
Studio.

> Does somebody use this tool for making Doxygen friendly with Visual
> Studio?

Visual Studio (at least since version 2003, maybe earlier) is able to generate
XML comments according to ECMA-334 standard (aka C# comments).
Doxygen is able to understand XML comments according to ECMA-334. So I would say
Visual Studio is already Doxygen-friendly (or vice versa). I don't quite see
your problem.

Best regards,
Lars Friedrich

-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files for
problems?  Stop!  Download the new AJAX search engine that makes searching your
log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
http://ads.osdn.com/?ad_idv37&alloc_id865&op=ick
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

********************** Legal Disclaimer **************************** "This email
may contain confidential and privileged material for the sole use of the
intended recipient.  Any unauthorized review, use or distribution by others is
strictly prohibited.  If you have received the message in error, please advise
the sender by reply email and delete the message. Thank you."
**********************************************************************

-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files for
problems?  Stop!  Download the new AJAX search engine that makes searching your
log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
http://ads.osdn.com/?ad_idv37&alloc_id865&op=ick
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems?  Stop!  Download the new AJAX search engine that makes
searching your log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
http://ads.osdn.com/?ad_id=7637&alloc_id=16865&op=click

headers

Moshe Kruger | 4 Jan 2006 15:40

Use of \retval and \return

Hi all,

Can users of this list tell me about their of use of the doxygen tags \retval and \return.

Beyond the syntactical difference (\retval can take the name of the return value), is there a difference in meaning?

TIA,

Moshe Kruger
AllWrite Information Design
Tel : +972-3-9607130
Mobile: +972-57-756-9093
mailto: moshe.kruger <at> gmail.com

Website: www.allwrite-design.com
-----------------------------------------------
APIs/SDKs * User manuals * White papers *
Training courseware * Marketing collateral

Mon	Tue	Wed	Thu	Fri	Sat	Sun

						1
2	3	4	5	6	7	8
9	10	11	12	13	14	15
16	17	18	19	20	21	22
23	24	25	26	27	28	29
30	31

42	May 2013
83	April 2013
75	March 2013
76	February 2013
84	January 2013
60	December 2012
37	November 2012
56	October 2012
55	September 2012
64	August 2012
97	July 2012
69	June 2012
81	May 2012
121	April 2012
88	March 2012
77	February 2012
43	January 2012
60	December 2011
46	November 2011
72	October 2011
84	September 2011
90	August 2011
95	July 2011
54	June 2011
76	May 2011
67	April 2011
59	March 2011
77	February 2011
57	January 2011
53	December 2010
36	November 2010
66	October 2010
94	September 2010
67	August 2010
84	July 2010
86	June 2010
67	May 2010
37	April 2010
52	March 2010
70	February 2010
51	January 2010
48	December 2009
87	November 2009
79	October 2009
88	September 2009
82	August 2009
44	July 2009
56	June 2009
123	May 2009
84	April 2009
75	March 2009
115	February 2009
68	January 2009
37	December 2008
93	November 2008
62	October 2008
79	September 2008
115	August 2008
57	July 2008
79	June 2008
58	May 2008
73	April 2008
58	March 2008
115	February 2008
161	January 2008
74	December 2007
63	November 2007
74	October 2007
56	September 2007
78	August 2007
82	July 2007
80	June 2007
65	May 2007
112	April 2007
125	March 2007
97	February 2007
69	January 2007
45	December 2006
46	November 2006
82	October 2006
94	September 2006
90	August 2006
99	July 2006
143	June 2006
48	May 2006
55	April 2006
125	March 2006
72	February 2006
86	January 2006
63	December 2005
128	November 2005
140	October 2005
115	September 2005
106	August 2005
80	July 2005
106	June 2005
142	May 2005
114	April 2005
107	March 2005
76	February 2005
76	January 2005
98	December 2004
106	November 2004
69	October 2004
100	September 2004
104	August 2004
164	July 2004
64	June 2004
55	May 2004
55	April 2004
118	March 2004
71	February 2004
77	January 2004
54	December 2003
80	November 2003
108	October 2003
121	September 2003
97	August 2003
131	July 2003
129	June 2003
155	May 2003
114	April 2003
187	March 2003
122	February 2003
116	January 2003
67	December 2002
68	November 2002
97	October 2002
106	September 2002
98	August 2002
93	July 2002
80	June 2002
20	May 2002