doxygen-users — List for users of doxygen

FW: [Doxygen-users] MSDN Style

[<ca...@Cr...>]

	Hi!

> -----Original Message-----
> From: Dimitri van Heesch [mailto:di...@st...]
> Sent: Friday, November 09, 2001 12:25 AM
> To: dox...@li...
> Subject: Re: [Doxygen-users] MSDN Style
>
>	... and even some IE specific stuff...

	Some one try this on Netscape (etc.)?
	I don't belief that this looks well (and you can see some one),
but I can't
understand why Microsoft include non IE style sheet into MSDN help.
	If there is few problems, I try to solve this.
	- Alexandr Chelpanov -

-----Original Message-----
From: Dimitri van Heesch [mailto:di...@st...]
Sent: Friday, November 09, 2001 12:25 AM
To: dox...@li...
Subject: Re: [Doxygen-users] MSDN Style


On Thu, Nov 08, 2001 at 08:25:21AM -0500, Christian Ratliff wrote:
> Hello all,
>=20
>   Has the MSDN style been merged into the code base in CVS yet? We use
that
> style for all of our auto-generated documentation now, but I would
prefer to
> move to a more recent release than 1.2.6. I have been monitoring the
recent
> change logs, but perhaps I overlooked its mention.
>=20

I'm still investigating the impact of Alexandr Chelpanov's patch.=20
It is quite huge, still has rough edges, and introduces a lot of
conditional=20
code (mostly only for html, and even some IE specific stuff), so from a=20
test/maintenance point of view I am not overly enthousiastic yet.

From a user point of view I can understand the MSDN style feature is
nice=20
though.

Regards,
  Dimitri


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

FW: [Doxygen-users] MSDN Style

[<ca...@Cr...>]

	Hi!
	Idea looks well, if some one write xmlread that will read
doxygen's xml and generate doxygen style html, I do not see any
problems to modify xmlread to MSDN style. But I couldn write
MSDN style from scratch.
	I think that is a best idea to remove RTF, Latex, Html, Man
from doxygen parser and divide doxygen into 5 programs:
	parser, rtfgen, latexgen, htmlgen, mangen.
	But I think that this work don't seize less than half year.

	- Alexandr Chelpanov -

-----Original Message-----
From: Morgenthaler, Germar [mailto:g.m...@vi...]
Sent: Friday, November 09, 2001 1:13 PM
To: dox...@li...
Subject: RE: [Doxygen-users] MSDN Style



>> Has the MSDN style been merged into the code base in CVS yet?
> I'm still investigating the impact of Alexandr Chelpanov's patch.=20
> It is quite huge, still has rough edges, and introduces a lot=20
> of conditional code (mostly only for html, and even some IE
> specific stuff), so from a test/maintenance point of view I am
> not overly enthousiastic yet.

First I must admit that I haven't seen this MSDN style nor do I know
how the patch looks/works, BUT as long as introducing a new style means
changing the "code base" I would suggest NOT to integrate it.

IMHO styles should be added thru some abstraction layer/interface.
XML based or whatever.

I would suggest that Dimitri concentrates on the "parser engine" and the
"style interface hooks". People that want styles could invest their time
into writing code for that interface instead of writing patches for one
specific style.

Sorry if this spoils the fun for some people and YES I hate Micro$oft
(if that matters ;-)

Regards,

Germar

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

RE: [Doxygen-users] MSDN Style

[Christian R. <cra...@de...>]

Dimitri,

  What can I do to help get this patch in? If it is through some "style
interface hook" mechanism, which Germar mentions, I am glad to offer
whatever assistance I can.
  As for Germar's political perspective, whatever! We are a Microsoft shop,
and right now I just want to convince people to start auto generating
documentation. The MSDN-style is my best chance to do that, since we are all
familiar with that format.

christian

+-----+
Christian Ratliff <cra...@de...>
Sr. Technology Architect
Core Libraries Group, DeLorme
"This is the very perfection of man, 
  to find out his own imperfections" -  St. Augustine




-----Original Message-----
From: Dimitri van Heesch [mailto:di...@st...] 
Sent: Thursday, November 08, 2001 4:25 PM
To: dox...@li...
Subject: Re: [Doxygen-users] MSDN Style


On Thu, Nov 08, 2001 at 08:25:21AM -0500, Christian Ratliff wrote:
> Hello all,
> 
>   Has the MSDN style been merged into the code base in CVS yet? We use 
> that style for all of our auto-generated documentation now, but I 
> would prefer to move to a more recent release than 1.2.6. I have been 
> monitoring the recent change logs, but perhaps I overlooked its 
> mention.
> 

I'm still investigating the impact of Alexandr Chelpanov's patch. 
It is quite huge, still has rough edges, and introduces a lot of conditional

code (mostly only for html, and even some IE specific stuff), so from a 
test/maintenance point of view I am not overly enthousiastic yet.

From a user point of view I can understand the MSDN style feature is nice 
though.

Regards,
  Dimitri


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

RE: [Doxygen-users] MSDN Style

[Morgenthaler, G. <g.m...@vi...>]

>> Has the MSDN style been merged into the code base in CVS yet?
> I'm still investigating the impact of Alexandr Chelpanov's patch.=20
> It is quite huge, still has rough edges, and introduces a lot=20
> of conditional code (mostly only for html, and even some IE
> specific stuff), so from a test/maintenance point of view I am
> not overly enthousiastic yet.

First I must admit that I haven't seen this MSDN style nor do I know
how the patch looks/works, BUT as long as introducing a new style means
changing the "code base" I would suggest NOT to integrate it.

IMHO styles should be added thru some abstraction layer/interface.
XML based or whatever.

I would suggest that Dimitri concentrates on the "parser engine" and the
"style interface hooks". People that want styles could invest their time
into writing code for that interface instead of writing patches for one
specific style.

Sorry if this spoils the fun for some people and YES I hate Micro$oft
(if that matters ;-)

Regards,

Germar

RE: [Doxygen-users] MSDN Style

[Prikryl,Petr <PRI...@sk...>]

Hi,

Dimitri wrote:
> On Thu, Nov 08, 2001 at 08:25:21AM -0500, Christian Ratliff wrote:
> > [...]
> >   Has the MSDN style been merged into the code base in CVS yet? We use
that
> > style for all of our auto-generated documentation now, but I would
prefer to
> > move to a more recent release than 1.2.6. I have been monitoring the
recent
> > change logs, but perhaps I overlooked its mention.
> 
> I'm still investigating the impact of Alexandr Chelpanov's patch. 
> It is quite huge, still has rough edges, and introduces a lot of
conditional 
> code (mostly only for html, and even some IE specific stuff), so from a 
> test/maintenance point of view I am not overly enthousiastic yet.

In my opinion, MSDN Style will always be IE specific, and 
it will probably be focused mainly on HTML.  If MSDN Style 
were to be merged into the official doxygen, wouldn't
it be easier to introduce it via another, MSDN-specific 
HTML-generator?  I think that this way it could be separated
from the rest of doxygen, and it could possibly be conditionally 
excluded during compilation for the environment where MSDN Style
does not make sense.  

Microsoft likes to make changes and it does not like to follow
standards, sometimes.  Too tight integration of MSDN Style 
could spoil the doxygen core later.

Regards,
  Petr


-- 
Petr Prikryl, SKIL, spol. s r.o., pri...@sk...

[Doxygen-users] doxysearch

[Pablo A. <alv...@te...>]

Hello everybody!

I'm experimenting some problems with the newest version of doxysearch
(latest CVS version of Doxygen (1.2.11-20011104)); we haven't had
problems with the previous versions...

I'm afraid, I cannot reproduce the error: sometimes it works, sometimes
the search results contains only char 0xFF, sometimes there are no
search results or I get a timeout of the server...
I can say that the behaviour changes after each index generation only,
so I suppose there is something wrong with the search.idx file.

Can anyone help me?  Suggestions are welcome!

Regards,

Pablo

-- =

Dipl.-Ing. Pablo Alvarado   <alv...@te...>
Lehrstuhl f=FCr Technische Informatik,    RWTH-Aachen
Ahornstr.55               Phone : ++49 241 80 23635
D-52074 Aachen            Fax   : ++49 241 80 22308

RE: [Doxygen-users] MSDN Style

[Henrik N. <He...@no...>]

I would also like to see this feature.

// Henrik N

> 
> I would like to see this as well. The MSDN style is really cool.
> 
> BTW, I am writing a small tool to integrate the help generated
> by doxygen into VS.NET. It looks cool, but it is still in development.
> 
> Regards
> Thomas
> 
> 
> > -----Original Message-----
> > From: dox...@li... 
> > Sent: Thursday, 08 November, 2001 14:37
> > To: dox...@li...
> > Subject: [Doxygen-users] MSDN Style
> > 
> > 
> > Hello all,
> > 
> >   Has the MSDN style been merged into the code base in CVS 
> > yet? We use that style for all of our auto-generated 
> > documentation now, but I would prefer to move to a more 
> > recent release than 1.2.6. I have been monitoring the recent 
> > change logs, but perhaps I overlooked its mention.
> > 
> > thank you,
> > christian
> > 
> > PS. For all those who replied to my "Comment Folding" query, 
> > whoops! I added the ! token to the comment and it worked like 
> > a charm. Thanks very much too all.
> 

[Doxygen-users] Nesting lists.

[Bob S. <do...@bo...>]

Is there a way to nest a bulleted list inside a numbered list.

-# numbered 1
-# numbered 2
	- bullet 1
	- bullet 2
-# numbered 3


Generates a seconded numbered list where I want the bullet list to be.

Thanks

Bob Stafford

Re: [Doxygen-users] MSDN Style

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

On Thu, Nov 08, 2001 at 08:25:21AM -0500, Christian Ratliff wrote:
> Hello all,
> 
>   Has the MSDN style been merged into the code base in CVS yet? We use that
> style for all of our auto-generated documentation now, but I would prefer to
> move to a more recent release than 1.2.6. I have been monitoring the recent
> change logs, but perhaps I overlooked its mention.
> 

I'm still investigating the impact of Alexandr Chelpanov's patch. 
It is quite huge, still has rough edges, and introduces a lot of conditional 
code (mostly only for html, and even some IE specific stuff), so from a 
test/maintenance point of view I am not overly enthousiastic yet.

From a user point of view I can understand the MSDN style feature is nice 
though.

Regards,
  Dimitri

RE: [Doxygen-users] MSDN Style

[Freudenberg, T. <tho...@cy...>]

I would like to see this as well. The MSDN style is really cool.

BTW, I am writing a small tool to integrate the help generated
by doxygen into VS.NET. It looks cool, but it is still in development.

Regards
Thomas


> -----Original Message-----
> From: dox...@li... 
> Sent: Thursday, 08 November, 2001 14:37
> To: dox...@li...
> Subject: [Doxygen-users] MSDN Style
> 
> 
> Hello all,
> 
>   Has the MSDN style been merged into the code base in CVS 
> yet? We use that style for all of our auto-generated 
> documentation now, but I would prefer to move to a more 
> recent release than 1.2.6. I have been monitoring the recent 
> change logs, but perhaps I overlooked its mention.
> 
> thank you,
> christian
> 
> PS. For all those who replied to my "Comment Folding" query, 
> whoops! I added the ! token to the comment and it worked like 
> a charm. Thanks very much too all.

[Doxygen-users] RE: Latex issues.

[Adam T. <ad...@fi...>]

> Hello-
> 
> I am having problems getting doxygen to work with the latex output.  I
> have the latest doxygen 1.2.11 and the latest miktex 2.1
> 
> Here are the errors that I'm getting. It seems to me that these look
> familar from the last time I installed, but I don't remember the fix..
> 
> ********
> 
> echo "Running latex..."
> \"Running latex...\"
> latex refman.tex
> This is TeX, Version 3.14159 (MiKTeX 2.1)
> (refman.tex
> LaTeX2e <2001/06/01>
> Babel <v3.7h> and hyphenation patterns for english, french, german,
> ngerman, du
> mylang, nohyphenation, loaded.
> (c:\program files\Latex\tex\latex\base\book.cls
> Document Class: book 2001/04/21 v1.4e Standard LaTeX document class
> (c:\program files\Latex\tex\latex\base\bk10.clo))
> (c:\program files\Latex\tex\latex\ltxmisc\a4wide.sty
> (c:\program files\Latex\tex\latex\ntgclass\a4.sty))
> (c:\program files\Latex\tex\latex\base\makeidx.sty) (fancyhdr.sty)
> (c:\program files\Latex\tex\latex\graphics\graphicx.sty
> (c:\program files\Latex\tex\latex\graphics\keyval.sty)
> (c:\program files\Latex\tex\latex\graphics\graphics.sty
> (c:\program files\Latex\tex\latex\graphics\trig.sty)
> (c:\program files\Latex\tex\latex\00miktex\graphics.cfg)
> (c:\program files\Latex\tex\latex\graphics\dvips.def)))
> (c:\program files\Latex\tex\latex\float\float.sty)
> (c:\program files\Latex\tex\latex\base\alltt.sty) (doxygen.sty
> (c:\program files\Latex\tex\latex\tools\calc.sty)
> (c:\program files\Latex\tex\latex\tools\array.sty))
> Writing index file refman.idx
> No file refman.aux.
> [1] [2]
> No file refman.toc.
> [1] [2]
> Chapter 1.
> (hierarchy.tex
> 
> LaTeX Warning: Reference `classCMyMenu' on page 1 undefined on input line
> 3.
> 
> 
> LaTeX Warning: Reference `classCDblBufMenu' on page 1 undefined on input
> line 5
> .
> 
> 
> LaTeX Warning: Reference `classCCachedMenu' on page 1 undefined on input
> line 7
> .
> 
> 
> LaTeX Warning: Reference `classCBitmapMenu' on page 1 undefined on input
> line 9
> .
> 
> 
> LaTeX Warning: Reference `classCShortcut' on page 1 undefined on input
> line 13.
> 
> 
> 
> LaTeX Warning: Reference `classCStartBarMod' on page 1 undefined on input
> line 
> 14.
> 
> 
> LaTeX Warning: Reference `classCStartBarModFactory' on page 1 undefined on
> inpu
> t line 15.
> 
> 
> LaTeX Warning: Reference `classCStartDlg' on page 1 undefined on input
> line 16.
> 
> 
> 
> LaTeX Warning: Reference `classCStartMenu' on page 1 undefined on input
> line 17
> .
> 
> ) [1] (c:\program files\Latex\tex\latex\base\omscmr.fd) [2]
> Chapter 2.
> (annotated.tex
> 
> LaTeX Warning: Reference `classCBitmapMenu' on page 3 undefined on input
> line 3
> .
> 
> 
> LaTeX Warning: Reference `classCCachedMenu' on page 3 undefined on input
> line 4
> .
> 
> 
> LaTeX Warning: Reference `classCDblBufMenu' on page 3 undefined on input
> line 5
> .
> 
> 
> LaTeX Warning: Reference `classCMyMenu' on page 3 undefined on input line
> 6.
> 
> 
> LaTeX Warning: Reference `classCShortcut' on page 3 undefined on input
> line 7.
> 
> 
> LaTeX Warning: Reference `classCStartBarMod' on page 3 undefined on input
> line 
> 8.
> 
> 
> LaTeX Warning: Reference `classCStartBarMod' on page 3 undefined on input
> line 
> 9.
> 
> 
> LaTeX Warning: Reference `classCStartBarModFactory' on page 3 undefined on
> inpu
> t line 9.
> 
> 
> LaTeX Warning: Reference `classCStartBarMod' on page 3 undefined on input
> line 
> 10.
> 
> 
> LaTeX Warning: Reference `classCStartDlg' on page 3 undefined on input
> line 10.
> 
> 
> 
> LaTeX Warning: Reference `classCStartMenu' on page 3 undefined on input
> line 11
> .
> 
> ) [3] [4]
> Chapter 3.
> (pages.tex
> 
> LaTeX Warning: Reference `todo' on page 5 undefined on input line 3.
> 
> ) [5] [6]
> Chapter 4.
> (classCBitmapMenu.tex <classCBitmapMenu.eps>
> ! Extra }, or forgotten \endgroup.
> \endfigure ... \fi \box \@currbox \egroup 
>                                           \vskip \intextsep \relax 
> l.13 \end{figure}
>                  
> ?
> 

[Doxygen-users] MSDN Style

[Christian R. <cra...@de...>]

Hello all,

  Has the MSDN style been merged into the code base in CVS yet? We use that
style for all of our auto-generated documentation now, but I would prefer to
move to a more recent release than 1.2.6. I have been monitoring the recent
change logs, but perhaps I overlooked its mention.

thank you,
christian

PS. For all those who replied to my "Comment Folding" query, whoops! I added
the ! token to the comment and it worked like a charm. Thanks very much too
all.

+-----+
Christian Ratliff <cra...@de...>
Sr. Technology Architect / Core Libraries Group
DeLorme Publishing Co.
"This is the very perfection of man, 
  to find out his own imperfections" -  St. Augustine

Re: [Doxygen-users] doxygen comannd for preformated text

[Jeroen t. H. <J.t...@ai...>]

Dirk,

> At the beginning of each file is a history for some change acitivy with its
> own format. So we want to get these information in the doxygen output
> (html, latex and pdf).
> 
> I use with the \file command to get the text, but without its own format.
> But the history was preformated and we don't want to change it.

I think you could use \verbatim and \endverbatim.

Tschuess,
Jeroen.

----------------------------------------------------------------------
Aia                                     Phone: +31 24 371 02 30
PO Box 38025                            Fax:   +31 24 371 02 31
6503 AA Nijmegen                        Email: J.t...@ai...
The Netherlands                         URL:   http://www.aia.nl
----------------------------------------------------------------------
This E-mail and any files transmitted with it are confidential and
intended solely for the use of the individual or entity to whom they
are adressed. If you have received this E-mail in error please notify
the postmaster (pos...@ai...). The authenticity of this message
cannot, at this moment, be guaranteed by ourselves. For this reason no
legal rights may be granted should the contents differ to the original
sent message. The Aia log-file of sent messages is deemed to be the
sole, true transcript of communication unless the contrary, other
than the received message, can be proven.
----------------------------------------------------------------------

[Doxygen-users] doxygen comannd for preformated text

[Dirk B. <dir...@de...>]

Hallo,

we have in our project lot of files and want to use doxygen for
documentation.

At the beginning of each file is a history for some change acitivy with=
 its
own format. So we want to get these information in the doxygen output
(html, latex and pdf).

I use with the \file command to get the text, but without its own forma=
t.
But the history was preformated and we don't want to change it.

The HTML statements <pre> and </per> solve  my problem, but i want to k=
now,
if doxygen has no own special command for it?

Gru=DF/Regards

Dirk Binz
IBM Laboratory Boeblingen
Support Processor Application Development (SPA)
Postfach 1380, D - 71003 Boeblingen, Germany
phone: +49-(0)7031-16-2128
mail: dir...@de...=

Re: [Doxygen-users] problem with param and return tags in latex

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

On Mon, Nov 05, 2001 at 11:32:15AM +0100, Mitja Udovc wrote:
> If you use \return and \param in doxygen followed with (-), you 
> get inappropriate latex code.
> 
> /*!
>  * \file
>  * Test 
>  * \brief test (brief)
>  * \return test (return)
>  * - first item (return)
>  * - second item (return)
>  * \param test (param)
>  * - first item (param) 
>  * - second item (param)	
>  */

Is this a problem in the latest CVS update? Because that should have
fixed the problem (and a small test of the above example indicates it did
for me!)

Regards,
  Dimitri

RE: [Doxygen-users] Comment Folding

[Glenn M. <gle...@vo...>]

Sorry to be chiming in late on this thread. I was on vacation.

As another person already pointed out, your comment above "void Bar();"
also needs to be a Doxygen formatted comment (e.g., "//! ...").

In addition, I would force it to be the brief description with:

//! @brief Establishes a connection to the properties database.
void Bar();

Do not have another brief description in the CPP file.

HTH,

Glenn Conrad Maxey
ma...@pr...
108 W. Byers Place #207=20
Denver, CO 80223 (USA)
(h) Tel. +1 303.282.4578
(w) Tel. +1 303.223.5164

[Home address and telephone may change soon. E-mail will remain valid.]

> -----Original Message-----
> From: Christian Ratliff [mailto:cra...@de...]
> Sent: Thursday, November 01, 2001 2:43 PM
> To: dox...@li...
> Subject: [Doxygen-users] Comment Folding
>=20
>=20
> doxygen-1.2.11.1
> Windows XP (release)
>=20
>   I noticed that doxygen does not appear to fold together the=20
> brief and
> detailed descriptions when producing the documentation. I=20
> segment my docs as
> follows:
>=20
> ---foo.h---
>=20
> class Foo
> {
> 	// Establishes a connection to the properties database.
> 	void Bar();
> }
> ---foo.h----
>=20
> --foo.cpp---
> /**
>  * More detailed information about this method without repeating the
>  * summary comment.
>  *
>  * @throws ...
>  *
>  * @author etc...
>  */
> Void Foo::Bar()
> {
> }
> --foo.cpp---
>=20
>   This allows people viewing the header to see the short=20
> description for the
> method, but reserves the large comment for the source file.=20
> It also prevents
> having duplicate copies of the same text. I had thought that=20
> these settings
> would fix it, but no luck:
>=20
> BRIEF_MEMBER_DESC      =3D YES
> REPEAT_BRIEF           =3D YES
> JAVADOC_AUTOBRIEF      =3D YES
>=20
>   Does anyone already fix this or some advice?
>=20
> Christian

[Doxygen-users] Simple enhancement suggestion for compiled HTML generation

[<Kla...@it...>]

I always wondered why my Doxgen generated CHM's had the title "HTML
Help" instead of what I sepcified as PROJECT_NAME.
Today I found that this is because of a missing Langauge specification
in the [OPTIONS] section of the .hhp file.

So I suggest to add a line=20
    t << "Language=3D0x409" << endl;
before
    t << "Title=3D" << Config_getString("PROJECT_NAME") << endl << endl;
in the function HtmlHelp::createProjectFile().

Even better would be to use the real language id but as far as I can see
this is currently not in the translator interface.

- Klaus G=FCtter

[Doxygen-users] problem with param and return tags in latex

[Mitja U. <mit...@zr...>]

If you use \return and \param in doxygen followed with (-), you 
get inappropriate latex code.

/*!
 * \file
 * Test 
 * \brief test (brief)
 * \return test (return)
 * - first item (return)
 * - second item (return)
 * \param test (param)
 * - first item (param) 
 * - second item (param)	
 */

[Doxygen-users] Doxygen-1.2.11-20011104 in CVS

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

Hi,

Here's what has changed since last release:
---------------------------------------------------------------------------------------
+ CHG: Rewrote a substantial part of the source code parser
       (SOURCE_BROWSER = YES). It is now more context sensitive and
       will generate more/better links (for typical C code there is still
       some work to do though).
+ ADD: Added option REFERENCES_RELATION that can be enabled in combination
       with SOURCE_BROWSER to produce for each function
       a list of all called/used members/functions/variables.
       The reverse list can now be enabled/disabled using the
       new REFERENCED_BY_RELATION option.
+ ADD: Added native support for typedefs of the  
       form "typedef void (__stdcall *name)()", where __stdcall can be any
       identifier. 
+ ADD: Included a patch by Stephen Goudge which adds an option 
       EXAMPLE_RECURSIVE to indicate whether or not example files should
       be searched recursively.
+ ADD: Included Latin2 patch by Mitja Udovc.
+ BUG: Fixed Parser bug for java initializers of the form = "\"/*"; 
+ BUG: Fixed LaTeX output problem when using \par followed by a (-) list.
+ BUG: Fixed LaTeX output bug in the related page index. 
+ BUG: Commands inside a conditional section would still appear in the
       result even if the section was disabled. 
+ BUG: Included idea by Roberto Bagnara to make running "make" in the LaTeX
       output autodetect how many times latex has to be run.
+ BUG: Included a patch by Johan Eriksson to fix a link problem in the
       "list of all member" for grouped members. 
+ BUG: Fixed potential crash when \todo was used without arguments.
---------------------------------------------------------------------------------------
Enjoy,
  Dimitri

RE: [Doxygen-users] Comment Folding

[Kris T. <kri...@ic...>]

it works for me... can't see anything wrong except  that you should do //!
in your brief comment.

if that wasn't it, are you sure you're processing both .h and .cpp files?

Kris

> -----Original Message-----
> From: dox...@li...
> [mailto:dox...@li...]On Behalf Of Christian
> Ratliff
> Sent: 01 November 2001 13:43
> To: dox...@li...
> Subject: [Doxygen-users] Comment Folding
>
>
> doxygen-1.2.11.1
> Windows XP (release)
>
>   I noticed that doxygen does not appear to fold together the brief and
> detailed descriptions when producing the documentation. I segment
> my docs as
> follows:
>
> ---foo.h---
>
> class Foo
> {
> 	// Establishes a connection to the properties database.
> 	void Bar();
> }
> ---foo.h----
>
> --foo.cpp---
> /**
>  * More detailed information about this method without repeating the
>  * summary comment.
>  *
>  * @throws ...
>  *
>  * @author etc...
>  */
> Void Foo::Bar()
> {
> }
> --foo.cpp---
>
>   This allows people viewing the header to see the short
> description for the
> method, but reserves the large comment for the source file. It
> also prevents
> having duplicate copies of the same text. I had thought that
> these settings
> would fix it, but no luck:
>
> BRIEF_MEMBER_DESC      = YES
> REPEAT_BRIEF           = YES
> JAVADOC_AUTOBRIEF      = YES
>
>   Does anyone already fix this or some advice?
>
> Christian
>
> +-----+
> Christian Ratliff <cra...@de...>
> Sr. Technology Architect / Core Libraries Group
> DeLorme Publishing Co.
> "This is the very perfection of man,
>   to find out his own imperfections" -  St. Augustine
>
>
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] Comment Folding

[Christian R. <cra...@de...>]

doxygen-1.2.11.1
Windows XP (release)

  I noticed that doxygen does not appear to fold together the brief and
detailed descriptions when producing the documentation. I segment my docs as
follows:

---foo.h---

class Foo
{
	// Establishes a connection to the properties database.
	void Bar();
}
---foo.h----

--foo.cpp---
/**
 * More detailed information about this method without repeating the
 * summary comment.
 *
 * @throws ...
 *
 * @author etc...
 */
Void Foo::Bar()
{
}
--foo.cpp---

  This allows people viewing the header to see the short description for the
method, but reserves the large comment for the source file. It also prevents
having duplicate copies of the same text. I had thought that these settings
would fix it, but no luck:

BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES
JAVADOC_AUTOBRIEF      = YES

  Does anyone already fix this or some advice?

Christian

+-----+
Christian Ratliff <cra...@de...>
Sr. Technology Architect / Core Libraries Group
DeLorme Publishing Co.
"This is the very perfection of man, 
  to find out his own imperfections" -  St. Augustine

Re: [Doxygen-users] Java packages

[Berno L. <ber...@ep...>]

Am Donnerstag, 1. November 2001 19:03 schrieben Sie:
> On Thu, Nov 01, 2001 at 02:29:21PM +0100, Berno Langer wrote:
> > Hello,
> >
> > is there any plan when doxygen will be able to handle java packages
> > completely? I prefer doxygen greatly over javadoc, but without this
> > feature it is nearly usesless.
>
> Could you explain what "completely" means for you?

That classes that have the same name and are in different packages are=20
distinguished. E.g. in the JUnit framework are packages for different fro=
nt=20
ends and each package contains a class TestRunner. Only the first TestRun=
ner=20
that is parsed by doxygen is taken, the others are ignored (or give error=
s=20
the the class TestRunner is documented already).

I don't know how much work it is to implement, that the classes have the=20
"namespace" of their package. But it would be really useful because even =
many=20
of the classes that come with Java have the same name. (And nearly all ja=
va=20
framewoks I use have that "problem" also.)

In general I like doxygen very much, but it's annoying that you can't rel=
y on=20
the generated documentation in this point (without interpreting the produ=
ced=20
error messages).

---
Gru=DF

Berno

Re: [Doxygen-users] 1.2.11.1 Compile Error on AIX 4.3.3

[<db...@ca...>]

Perfect!  Appending <T> to ValStack did the trick!

FYI - attached below is a diff on xmlgen.cpp....   I just want to take this
opportunity to say that you and all other Doxygen developers have done a
fantastic job!

*** xmlgen.cpp.orig     Thu Nov  1 13:24:52 2001
--- xmlgen.cpp  Thu Nov  1 13:25:14 2001
***************
*** 109,123 ****
  {
    public:
      ValStack() : m_values(10), m_sp(0), m_size(10) {}
      virtual ~ValStack() {}
!     ValStack(const ValStack &s)
      {
        m_values=s.m_values.copy();
        m_sp=s.m_sp;
        m_size=s.m_size;
      }
!     ValStack &operator=(const ValStack &s)
      {
        m_values=s.m_values.copy();
        m_sp=s.m_sp;
        m_size=s.m_size;
--- 109,123 ----
  {
    public:
      ValStack() : m_values(10), m_sp(0), m_size(10) {}
      virtual ~ValStack() {}
!     ValStack(const ValStack<T> &s)
      {
        m_values=s.m_values.copy();
        m_sp=s.m_sp;
        m_size=s.m_size;
      }
!     ValStack<T> &operator=(const ValStack<T> &s)
      {
        m_values=s.m_values.copy();
        m_sp=s.m_sp;
        m_size=s.m_size;

-


Dimitri van Heesch <di...@st...> on 11/01/2001 01:13:15 PM

Please respond to Dimitri van Heesch <di...@st...>

To:   Dan Behman/Toronto/IBM@IBMCA
cc:
Subject:  Re: [Doxygen-users] 1.2.11.1 Compile Error on AIX 4.3.3


On Thu, Nov 01, 2001 at 10:04:53AM -0500, db...@ca... wrote:
> Hello,
>
> I'm seeing this compile error on AIX 4.3.3 with xlc 3.6.6:
>
> "xmlgen.cpp", line 113.29: 1540-090: (S) Syntax error - expected "<" and
> found "&".
> "xmlgen.cpp", line 119.14: 1540-090: (S) Syntax error - expected "<" and
> found "&".
> "xmlgen.cpp", line 734.5: 1540-206: (I) The previous 2 messages apply to
> the definition of template
> "ValStack<int>".
> gmake[1]: *** [../objects/xmlgen.o] Error 1
>
> Can anybody help me out?

Hmm, it seems your compiler has problems with templates.
You can try to replace ValStack with ValStack<T> at the points you
get an error. Please let me know if this works for you.

Regards,
  Dimitri

Re: [Doxygen-users] Java packages

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

On Thu, Nov 01, 2001 at 02:29:21PM +0100, Berno Langer wrote:
> Hello,
> 
> is there any plan when doxygen will be able to handle java packages 
> completely? I prefer doxygen greatly over javadoc, but without this feature 
> it is nearly usesless.

Could you explain what "completely" means for you?

Regards,
  Dimitri

[Doxygen-users] Java packages

[Berno L. <ber...@ep...>]

Hello,

is there any plan when doxygen will be able to handle java packages=20
completely? I prefer doxygen greatly over javadoc, but without this featu=
re=20
it is nearly usesless.

---
Gru=DF

Berno