doxygen-users — List for users of doxygen

Re: [Doxygen-users] conditional documentation

[Dimitri v. H. <di...@st...>]

On Wed, Aug 01, 2001 at 09:39:44AM +0200, Klaus Vrana wrote:
> Hi everybody!
> 
> I have the following question.
> 
> Is the feature of conditional documentation restricted to "docu" only?
> 
> I want to use the @if - @endif - feature like  
> 
>     /** @if MY_LABEL1
>     * @defgroup ctest1 Group1
>     * @endif 
>     */       
>        
>        
>    /** @if MY_LABEL2
>      * @defgroup ctest2 Group2
>      * @endif 
>      */
>      
>      
> 
> /** @class middle
> 
>     @if MY_LABEL1
>     
>     @ingroup ctest1 
> 
>     description 1
>     @endif
>     
>     @if MY_LABEL2
>     
>     @ingroup ctest2
>     description 2
>     @endif
>     
>  */  
> 
> but all used commands (@defgroup / @ingroup ) are ignored in the way that both groups are generated
> and that the class is added to each group. The description part itself is handled correctly.
> 
> Is this a bug or is it the way doxygen should work or what else is wrong?

It is kind-of a bug. Doxygen handles the @if's in the second parsing pass (in doc.l), while it
should have done it in the first pass (in scanner.l). That's why a number of commands 
(including @brief) cannot be properly @if'ed. I will fix this, but not before 1.2.9, which 
I am currently preparing.

Regards,
  Dimitri

[Doxygen-users] conditional documentation

[Klaus V. <Kla...@ga...>]

Hi everybody!

I have the following question.

Is the feature of conditional documentation restricted to "docu" only?

I want to use the @if - @endif - feature like =20

    /** @if MY_LABEL1
    * @defgroup ctest1 Group1
    * @endif=20
    */      =20
      =20
      =20
   /** @if MY_LABEL2
     * @defgroup ctest2 Group2
     * @endif=20
     */
    =20
    =20

/** @class middle

    @if MY_LABEL1
   =20
    @ingroup ctest1=20

    description 1
    @endif
   =20
    @if MY_LABEL2
   =20
    @ingroup ctest2
    description 2
    @endif
   =20
 */ =20

but all used commands (@defgroup / @ingroup ) are ignored in the way that =
both groups are generated
and that the class is added to each group. The description part itself is =
handled correctly.

Is this a bug or is it the way doxygen should work or what else is wrong?


Thanks
Klaus Vrana

=20

[Doxygen-users] patch for reordering sections

[Hunter M. <hma...@vi...>]

I have blundered into the source and found a way to create the
ordering I have recently asked about on this list. I am not posting
the patch because it is not clear I have done things the best way. I
am looking for helpful input from more experienced doxygen hackers.

Let me reduce my goal to the basics: I wanted to have "sections" under
my control that preceded the class documentation (in rtf or latex format).

After poking around I did a quick relocation of the following code
snippet to precede the other documentation sections (but after the
call to ol.lastIndexPage() )

  if (documentedPages>0)
  {
    ol.startIndexSection(isPageDocumentation);
    parseText(ol,projPrefix+theTranslator->trPageDocumentation());
    ol.endIndexSection(isPageDocumentation);
  }

This is in index.cpp:writeIndex().


Is there a better way to diddle the large-scale structure of the
generated doc? 


BTW, is there a doxygen config file for running doxygen on the doxygen
source code. I was too obsessed to be diverted into doing something
efficiently helpful. :-) It is in fact the greatest known irony that I
manually browsed the source and did a couple greps to find out some
stuff about an automated source code document/cross-reference tool
(which reflects my own foolish laziness).

	hunter

[Doxygen-users] HTML links to local file system

[Chris S. <cj...@jl...>]

Group,
    I am trying to enter HTML links into my document produced by
doxygen.  I put the following in
one of my files..

/*! \page page2 Links
 - <a href="http://www.trolltech.com">Qt GUI library</a>
 - <a href="http://www.humanfactor.com/pthreads/">POSIX Threads</a>
 - <a href="file://d:\cjs\doc\lecroy.pdf">Software Documentation</a>
*/

The two web links work fine.  The link to the local file does not.  If I
cut the HTML out and put it into a text file, I can open it with my
browser and successfully follow all three links, which shows they are
valid.  The actual link generated from this HTML, after running through
doxygen, is changed to the path of my index.html generated by doxygen.
Does doxygen do some parsing and translating of the HTML code?

         Thanks,
             Chris

RE: [Doxygen-users] Pictures in RTF with Word 2000

[CHUVALA, K. G. (JSC-D. (USA) <kei...@js...>]

> From: Jeff Garland [mailto:je...@cr...]
> 
> It appears that there is a bug in the RTF generation.  

A month or so ago the fix for this problem was placed into the CVS
distribution (and I assume is still in it <g>).

kgc

______________________________________
Keith G. Chuvala
Space Operations Computing (SpOC) Team
Johnson Space Center
Houston, Texas, USA

RE: [Doxygen-users] Pictures in RTF with Word 2000

[Jeff G. <je...@cr...>]

Susanne --

Thank you.  On your suggestion I took a closer look.

It appears that there is a bug in the RTF generation.  No matter what, the RTF
picture references are wrong.  With CASE_SENSITIVE_NAMES set to NO, the RTF has
obviously wrong names like:

classMixedCaseName_inherit_graph.gif

when the file is named something like: class_m_ixed_c_ase_n_ame_inherit_graph

With CASE_SENSITIVE_NAMES = YES the RTF gets the same name, but the file has a
couple extra underscores in the name:

RTF:  classMixedCaseName_inherit_graph.gif
File: classMixedCaseName__inherit__graph.gif

Not easy to spot.  But, once you know, a couple of quick commands in emacs fixed
that right up :-)

Jeff


> -----Original Message-----
> From: Susanne Muris [mailto:sus...@t-...]
> Sent: Sunday, July 29, 2001 7:08 PM
> To: je...@cr...
> Subject: RE: [Doxygen-users] Pictures in RTF with Word 2000
>
>
> This message was sent from Geocrawler.com by "Susanne Muris"
> <sus...@t-...>
>
>
> Did you compary the names of the referenced files
> in the field function with the actual file names?
> I assume they're different. I had a similar
> problem, observed problems in class names with
> colons and on each instance when a capital letter
> was used within a class name. I could resolve the
> issue only partially by setting the switch for
> case-sensitive file names in the configuration
> file to YES.
>
> ---------------------------------------
>
> When I generate RTF documents with embedded
> graphics from Graphviz, the graphics
> don't show up in my word document.  A picture
> frame is there, and a cursory
> glance at indicates that the INCLUDEPICTURE is in
> the RTF and looks reasonable
> (I'm no RTF expert). I am using word 2000 to read
> the generated RTF from Doxygen
> 1.2.8.1.
>
> Seems to me I someone else had a similar problem,
> but the mail archive isn't
> searchable :-(  Ideas?
>
> Thx
>
> Jeff
>
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxyge
> n-users
>
>
>
> Geocrawler.com - The Knowledge Archive
>

RE: [Doxygen-users] language dependent output

[Tobias Z. <zi...@te...>]

Hello Olexij,
I'm building multilingual documentation too. I encountered the problem you
are discribing only using the @brief command (see my former postings).
Dimitri told me it is a parser bug but it is on his fix list.

Conditional documentation works fine for me on any other commands than
@brief. Is that different with your docu?

Regards
	Tobias

-----Original Message-----
From: dox...@li...
[mailto:dox...@li...]On Behalf Of Olexij
Tkatchenko
Sent: Sunday, July 29, 2001 12:14 PM
To: dox...@li...
Subject: [Doxygen-users] language dependent output


Does anyone anyone know how to produce language-dependent output with
doxygen? I have tried to define conditional sections with \if-\endif
statements surrounding parts of comment block, but doxygen ignores them
and just concatenates comment blocks content.

Thanks for help
Olexij



_______________________________________________
Doxygen-users mailing list
Dox...@li...
http://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] language dependent output

[Olexij T. <ole...@gm...>]

Does anyone anyone know how to produce language-dependent output with 
doxygen? I have tried to define conditional sections with \if-\endif 
statements surrounding parts of comment block, but doxygen ignores them 
and just concatenates comment blocks content.

Thanks for help
Olexij

[Doxygen-users] controlling document structure with "@page" and C/C++ source together

[Hunter M. <hma...@vi...>]

I am trying to have my code documentation show up as the last
"section" of a document generated from both *.{c,h} and .doc files
using the @page special (as is done in the Doxygen documentation
itself to control the doument structure [that and the ordering of the
files on the INPUT field]). Think MIL-STD 498 SDD.  :-(

Unfortunately, the presence of any C/C++ code (as opposed to regular
prose inside a @page block) causes Doxygen to follow it's own ordering
of the various sections (Page, Classes, Modules, etc).

Does anyone have any hints as to how to get better control over
document structure, or possibly where in the Doxygen code I code hack
around the default orderings?

Thanks

	hunter

[Doxygen-users] Pictures in RTF with Word 2000

[Jeff G. <je...@cr...>]

When I generate RTF documents with embedded graphics from Graphviz, the graphics
don't show up in my word document.  A picture frame is there, and a cursory
glance at indicates that the INCLUDEPICTURE is in the RTF and looks reasonable
(I'm no RTF expert). I am using word 2000 to read the generated RTF from Doxygen
1.2.8.1.

Seems to me I someone else had a similar problem, but the mail archive isn't
searchable :-(  Ideas?

Thx

Jeff

[Doxygen-users] Doxygen gets good exposure from Borland

[CHUVALA, K. G. (JSC-D. (USA) <kei...@js...>]

I've just returned home from the Borland Conference in Long Beach, CA USA,
and thought I'd pass this on to the Doxygen list.  In previews for the next
release of C++ Builder, and during a technology keynote address to all
conference attendees, the product manager for the product demonstrated the
integration of tools into its IDE, and the example he used was Doxygen!
He'd added an RTF control so that the Doxygen-generated output could be
viewed on-demand, and demonstrated how it all worked together.  

Our merry little band of Doxy-fans let out a cheer for our favorite source
code documenting tool.

kgc

______________________________________
Keith G. Chuvala
Space Operations Computing (SpOC) Team
Johnson Space Center
Houston, Texas, USA

Re: [Doxygen-users] Compiling tarball version ends with bison error - do you have any hints ?

[Dimitri v. H. <di...@st...>]

On Wed, Jul 25, 2001 at 11:59:24AM +0200, Peter Thieß wrote:
> 
> bison: Bad address
> 
> NMAKE : fatal error U1077: 'bison': return code '0x2'

If you are using cygwin for windows, then run a bash 
and type `mkdir /tmp'. The problem seems to be caused 
by bison not being able to write to "/tmp"!

Regards,
  Dimitri

Re: [Doxygen-users] Repost: brief command in conditional parts of the documentation

[Dimitri v. H. <di...@st...>]

On Wed, Jul 25, 2001 at 11:41:45AM +0200, Tobias Zimmer wrote:
> Perhaps now someone is interested in this problem too.
> 
> I'd really like to know whether this is a bug in the parser or not.

It is probably a parser bug. It is (still) on my list of things to
look at.

Regards,
  Dimitri

[Doxygen-users] Another RTF extensions file

[Darren B. <db...@ga...>]

As long as we're on the topic, I was hoping this extensions file would allow
be to define header or footer text.  I don't need any special font control.
I didn't see any switch that would do that.  Did I miss something?  Can we
add it to a wish list?

--Darren
Gadzoox Networks

Re: [Doxygen-users] Documenting C structs

[Clayton C. <crc...@cs...>]

	Well, you obviously know the language(s) better than I, but I
was thinking that Doxygen should provide the user with the flexibily
and freedom to document just and only what they want to document, and
that it should also give them a certain (reasonable) amount of freedom
to do so in whichever way that they see fit.

	Now, I've made the above assertion based upon what I already
know about the system: Doxygen lets the coder use the Qt or Javadoc
syntax; it lets the coder document function arguments beforehand or
inline; and it lets the coder document the code in a file or files
that're completely divorced from the code.  These points alone show
that the system is already trying to be rather flexible, and -- it
seems to me -- that this @member (or whatever) wouldn't be too bad of
thing to add in the name of flexibilty.  (Of course, the fact that it
seems I'm the only one to have asked or to be asking for this kind of
thing certainly goes wuite a way in arguing against me, eh?)

	Granted, the situation could get rather hairy when function
pointers or member functions are encoutered, but I seem to think that
those are substantial enough members to to make documenting then
within the struct/class, as opposed to beforehand, quite feasible.

	I'm sorry if I sound beligerent.  I really do like Doxygen and
I'm very appreciative of the work that's already been put into it.

--c



On Wed, Jul 25, 2001 at 10:37:26AM -0400, Wagner, Victor wrote:
> Shall we also, then, ask that local, namespace, and global variables be
> documented in the same fashion?
> If so, what about variables declared "way down" in the middle of the code?
> 
> Please note I'm not advocating this (yet), I'm just trying to get the entire
> story.
> 
> From: Clayton Carter [mailto:crc...@cs...]
> Sent: Wednesday, 2001 July 25 10:19
> To: dox...@li...
> Subject: Re: [Doxygen-users] Documenting C structs
> 
> 
> 	Because I'd like to have the flexibility of being able to
> document the structs/unions/classes the same way that functions are
> documented.  It's possible to document functions beforehand (ie - with
> @param) or inline (ie - with the /*!< notation) and I think it'd be
> handy to have the same for structs/classes.  By documenting the
> (whatever) beforehand (but, of course, keeping that documentation
> close at hand), you can keep the (whatever) declaration simple and
> concise.  For instance
> 
> 	...
> 	* @member min blah blah min blah
> 	* @member max blah max blah blah
> 	...
> 	...
> 	double min, max;
> 	...
> 
> 	instead of something like:
> 
> 	...
> 	double min;   /*!< blah blah min blah, possibly
> 		       *   stretching over
> 		       *   multiple lines, right? */
> 	/*! blah max blah blah */
> 	double max;
> 	...
> 
> 	of course, any not-insane person would try to use a consistent
> method over both definitions, but I still think that the former is
> more elegant and readable.
> 
> 
> 
> On Tue, Jul 24, 2001 at 06:57:21PM -0400, Wagner, Victor wrote:
> wronw
> 

-- 
Clayton Carter   crc...@cs...
"My mom says I'm the handsomest guy in school."

RE: [Doxygen-users] Documenting C structs

[Wagner, V. <VW...@se...>]

Shall we also, then, ask that local, namespace, and global variables be
documented in the same fashion?
If so, what about variables declared "way down" in the middle of the code?

Please note I'm not advocating this (yet), I'm just trying to get the entire
story.

-----Original Message-----
From: Clayton Carter [mailto:crc...@cs...]
Sent: Wednesday, 2001 July 25 10:19
To: dox...@li...
Subject: Re: [Doxygen-users] Documenting C structs


	Because I'd like to have the flexibility of being able to
document the structs/unions/classes the same way that functions are
documented.  It's possible to document functions beforehand (ie - with
@param) or inline (ie - with the /*!< notation) and I think it'd be
handy to have the same for structs/classes.  By documenting the
(whatever) beforehand (but, of course, keeping that documentation
close at hand), you can keep the (whatever) declaration simple and
concise.  For instance

	...
	* @member min blah blah min blah
	* @member max blah max blah blah
	...
	...
	double min, max;
	...

	instead of something like:

	...
	double min;   /*!< blah blah min blah, possibly
		       *   stretching over
		       *   multiple lines, right? */
	/*! blah max blah blah */
	double max;
	...

	of course, any not-insane person would try to use a consistent
method over both definitions, but I still think that the former is
more elegant and readable.

--c


On Tue, Jul 24, 2001 at 06:57:21PM -0400, Wagner, Victor wrote:
> given that the differences between struct and class is minimal, what's
wronw
> with the way it documents them now?
> 
> From: Clayton Carter [mailto:crc...@cs...]
> Sent: Tuesday, 2001 July 24 17:36
> To: dox...@li...
> Subject: [Doxygen-users] Documenting C structs
> 
> 
> 	What have folks found to be the best way of documenting C
> structs?  I was hoping that there'd be a command `@member' so that
> structs could be documented like functions.  For instance, we've got
> this:
> 
> /**
>  * Function to init some data
>  * @param inFile ...
>  * @return ...
>  */
> int init_data( char *inFile )
> 
> 	and we can also use the `/*!<' syntax to document `inFile'
> right where we define it.  Anyway, it seems as this on location
> documentation is only option when working with structs.  I'd like
> something like this:
> 
> /**
>  * @struct data
>  * @brief ...
>  * @member mins ...
>  * @member maxs ...
>  * @member means ...
>  * etc.
>  */
> 
> typedef struct {
>   double mins, maxs, means, medians, sigs, totals;
> } data;
> 
> 
> 	Please chastise me if I'm way off base here.  I've scanned the
> docs, but not seen anything like what [I think] I'm talking about.
> Thanks.
> 
> 

-- 
Clayton Carter   crc...@cs...
"My mom says I'm the handsomest guy in school."

_______________________________________________
Doxygen-users mailing list
Dox...@li...
http://lists.sourceforge.net/lists/listinfo/doxygen-users


This transmission may contain information that is privileged, confidential
and exempt from disclosure under applicable law.
If you are not the intended recipient, you are hereby notified that any
disclosure, copying, distribution, or use of the information contained
herein (including any reliance thereon) is STRICTLY PROHIBITED.
If you received this transmission in error, please immediately contact the
sender and destroy the material in its entirety, whether in electronic or
hard copy format.
Thank you

Re: [Doxygen-users] Documenting C structs

[Clayton C. <crc...@cs...>]

	Because I'd like to have the flexibility of being able to
document the structs/unions/classes the same way that functions are
documented.  It's possible to document functions beforehand (ie - with
@param) or inline (ie - with the /*!< notation) and I think it'd be
handy to have the same for structs/classes.  By documenting the
(whatever) beforehand (but, of course, keeping that documentation
close at hand), you can keep the (whatever) declaration simple and
concise.  For instance

	...
	* @member min blah blah min blah
	* @member max blah max blah blah
	...
	...
	double min, max;
	...

	instead of something like:

	...
	double min;   /*!< blah blah min blah, possibly
		       *   stretching over
		       *   multiple lines, right? */
	/*! blah max blah blah */
	double max;
	...

	of course, any not-insane person would try to use a consistent
method over both definitions, but I still think that the former is
more elegant and readable.

--c


On Tue, Jul 24, 2001 at 06:57:21PM -0400, Wagner, Victor wrote:
> given that the differences between struct and class is minimal, what's wronw
> with the way it documents them now?
> 
> From: Clayton Carter [mailto:crc...@cs...]
> Sent: Tuesday, 2001 July 24 17:36
> To: dox...@li...
> Subject: [Doxygen-users] Documenting C structs
> 
> 
> 	What have folks found to be the best way of documenting C
> structs?  I was hoping that there'd be a command `@member' so that
> structs could be documented like functions.  For instance, we've got
> this:
> 
> /**
>  * Function to init some data
>  * @param inFile ...
>  * @return ...
>  */
> int init_data( char *inFile )
> 
> 	and we can also use the `/*!<' syntax to document `inFile'
> right where we define it.  Anyway, it seems as this on location
> documentation is only option when working with structs.  I'd like
> something like this:
> 
> /**
>  * @struct data
>  * @brief ...
>  * @member mins ...
>  * @member maxs ...
>  * @member means ...
>  * etc.
>  */
> 
> typedef struct {
>   double mins, maxs, means, medians, sigs, totals;
> } data;
> 
> 
> 	Please chastise me if I'm way off base here.  I've scanned the
> docs, but not seen anything like what [I think] I'm talking about.
> Thanks.
> 
> 

-- 
Clayton Carter   crc...@cs...
"My mom says I'm the handsomest guy in school."

[Doxygen-users] Environment vars in RTF Extensions

[<Mar...@no...>]

Hello!

When I create the RTF Extension with 'doxygen -eRTF rtf_ext' and invoke it
via RTF_EXTENSIONS_FILE = rtf_ext everthing seems to be ok, except that it
seems not to be possible to use environment variables in this extension
file.
They are just listed as text, although they do work in the 'calling'
configuration file.

Is this feature not implemented or am I just doing someyhing wrong?
(Dimitri??)
Any idea?

Regards,
 Markus Lepper

[Doxygen-users] Using links for dotty

[carine a. <ca...@te...>]

Hi everybody,

I am using dotty.exe with DOxygen to realize some functions graph. But I
don't know how to realize a Html link between the node representing a
function and its code itself.
Does anybody knows how to do?

Thanks a lot

Regards

Carine

RE: [Doxygen-users] Question about PREPROCESSING : Problems with Macro without semico lon

[Catenacci, O. <Ono...@co...>]

Hi Johannes,

Why not just put a semicolon at the end of the DECLARE_SERIAL line?  It's
not hurting anything--it's simply a dead statement as far as the compiler is
concerned.  I've had to do this repeatedly (add a dummy ; at the end of
Macro lines) in order to get an editor with smart indenting to work
correctly.  I'm not aware of any reason not to place the ; there.

--
Onorio Catenacci

"When one of them guys hits a single to you, throw the ball to third.  That
way we can hold them to a double."

--Casey Stengel addressing himself to the less than stellar outfielders of
the 1962 New York Mets.

> -----Original Message-----
> From: Kilian, Johannes [mailto:jk...@is...]
> Sent: Wednesday, July 25, 2001 3:50 AM
> To: 'dox...@li...'
> Subject: [Doxygen-users] Question about PREPROCESSING : Problems with
> Macro without semico lon
> 
> 
> Hi there,
> 
> I' ve got the following problem documenting with doxygen and 
> I'm searching
> for an solution:
> 
> My documentation of a class (using MFC) looks like:
> 
> -------------------------
> /*!
>   \class CClass
> 
>   \brief blablabla
> 
>   ...
> */
> class CClass : public CObject
> {
> 	DECLARE_SERIAL(CClass)
> 
> protected:
> 	//! Desription of the member
> 	double		member;
> }
> ------------------------------
> 
> Applying doxygen on this class, the macro DECLARE_SERIAL 
> appears as a class
> member - which is more or less correct.
> >>> But all the data-members after the Macro do not appear in the
> documentation! (The missing semicolon after the macto 
> confuses doxygen: the
> keyword "protected" is considered as a part of the line 
> without semicolon
> ...)
> (I've tried to solve it with the solution suggested in 
> doxygen-FAQ Question
> 2 - using the PREDEFINED ... setting - but I didn't succeed ...)
> 
> Thanks
> 
> Johannes
> 
> Johannes Kilian
> Entwicklung / Development
> ISRA VISION SYSTEMS AG
> E-Mail : mailto:jk...@is...
> 
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxygen-users
> 

[Doxygen-users] Compiling tarball version ends with bison error - do you have any hints ?

[<ph...@ra...>]

bison: Bad address

NMAKE : fatal error U1077: 'bison': return code '0x2'
...

Thanks in advance
Best Regards / Mit freundlichen Gr=FC=DFen

Peter
mailto:ph...@ra...

[Doxygen-users] Repost: brief command in conditional parts of the documentation

[Tobias Z. <Tob...@cw...>]

Perhaps now someone is interested in this problem too.

I'd really like to know whether this is a bug in the parser or not.

Regards
	Tobias

-----Original Message-----
From: Tobias Zimmer [mailto:Tob...@cw...]
Sent: Wednesday, June 20, 2001 7:39 AM
To: Doxygen-Liste
Subject: brief command in conditional parts of the documentation


Hi,
did anyone ever try to use the "brief"-command in or with conditional
commands "if" and "endif"?
I tried the following:

/**
*   \if eng
*   @brief  Function for handling UDP errors.
*
*   \endif
*
*   \if ger
*   @brief  Funktion zur Behandlung von UDP-Fehlern.
*
*   \endif
*/
int UDP_err(int err_code);

but doxygen always puts both @brief discriptions into the documentation no
matter whether I
set ENABLED_SECTIONS to eng (x)or ger.

I'd really like to use the "brief"-command cause the project I'm trying to
document is quite complex. Did anyone here build multilingual documentation
using brief discription? Or does anyone know how to this problem?

Thanks,
	Tobias

---
Tobias Zimmer
Tob...@cw...

[Doxygen-users] Question about PREPROCESSING : Problems with Macro without semico lon

[Kilian, J. <jk...@is...>]

Hi there,

I' ve got the following problem documenting with doxygen and I'm searching
for an solution:

My documentation of a class (using MFC) looks like:

-------------------------
/*!
  \class CClass

  \brief blablabla

  ...
*/
class CClass : public CObject
{
	DECLARE_SERIAL(CClass)

protected:
	//! Desription of the member
	double		member;
}
------------------------------

Applying doxygen on this class, the macro DECLARE_SERIAL appears as a class
member - which is more or less correct.
>>> But all the data-members after the Macro do not appear in the
documentation! (The missing semicolon after the macto confuses doxygen: the
keyword "protected" is considered as a part of the line without semicolon
...)
(I've tried to solve it with the solution suggested in doxygen-FAQ Question
2 - using the PREDEFINED ... setting - but I didn't succeed ...)

Thanks

Johannes

Johannes Kilian
Entwicklung / Development
ISRA VISION SYSTEMS AG
E-Mail : mailto:jk...@is...

[Doxygen-users] Patch + List item bug in 1.2.8-20010617

[Jens S. <jen...@hr...>]

I found the following bug in doxygen-1.2.8_20010723:

\mainpage
<ol>
  <li> First
  <li> - Second.1
       - Second.2
  <li> Third
</ol>

creates

 1. First
 2. - Second.1
         * Second.2
         * Third

instead of

 1. First
 2. * Second.1
    * Second.2
 3. Third

If I split "<li> - Second.1" into
<li>
    - Second.1
I get a slightly different output (but not the expected one).


I attached a small patch, which fixes some typos and updates the spec file.

PS:
www.doxygen.org/download.html#cvs contains:

cvs co doxygen              <<< remove !!!
 After that you can use
cvs co doxygen

Dimitri, please remove the first "cvs co doxygen".


Regard
Jens Seidel

RE: [Doxygen-users] Documenting C structs

[Wagner, V. <VW...@se...>]

given that the differences between struct and class is minimal, what's wronw
with the way it documents them now?

-----Original Message-----
From: Clayton Carter [mailto:crc...@cs...]
Sent: Tuesday, 2001 July 24 17:36
To: dox...@li...
Subject: [Doxygen-users] Documenting C structs


	What have folks found to be the best way of documenting C
structs?  I was hoping that there'd be a command `@member' so that
structs could be documented like functions.  For instance, we've got
this:

/**
 * Function to init some data
 * @param inFile ...
 * @return ...
 */
int init_data( char *inFile )

	and we can also use the `/*!<' syntax to document `inFile'
right where we define it.  Anyway, it seems as this on location
documentation is only option when working with structs.  I'd like
something like this:

/**
 * @struct data
 * @brief ...
 * @member mins ...
 * @member maxs ...
 * @member means ...
 * etc.
 */

typedef struct {
  double mins, maxs, means, medians, sigs, totals;
} data;


	Please chastise me if I'm way off base here.  I've scanned the
docs, but not seen anything like what [I think] I'm talking about.
Thanks.

--pc

-- 
Clayton Carter   crc...@cs...
"My mom says I'm the handsomest guy in school."

_______________________________________________
Doxygen-users mailing list
Dox...@li...
http://lists.sourceforge.net/lists/listinfo/doxygen-users


This transmission may contain information that is privileged, confidential
and exempt from disclosure under applicable law.
If you are not the intended recipient, you are hereby notified that any
disclosure, copying, distribution, or use of the information contained
herein (including any reliance thereon) is STRICTLY PROHIBITED.
If you received this transmission in error, please immediately contact the
sender and destroy the material in its entirety, whether in electronic or
hard copy format.
Thank you