doxygen-users — List for users of doxygen

[Doxygen-users] Doxygen-1.2.7-20010517 in CVS

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

Hi,

I've commited a new release to CVS. Here's the changelog:
------------------------------------------------------------------------
+ ADD: The dot generated inheritance and collaboration graphs for classes
       should now show the proper template instantation for the derived/used
       classes. For instance it should show that class S uses class V
       (indirectly) in the following example:
           class V {};
           template<class T> class U1 { T *m_t; };
           template<class T> class U2 { U1<T> *m_t; };
           template<class T> class B1 { U2<T> *m_t; };
           template<class T> class B2 : public B1<T> {};
           class S : public B2<V> {};
       Please report any example of class hierarchies that are not shown
       properly.
+ ADD: Added doc/translator.pl script created by Petr Prikryl.
       Its main purpose is to extract information from doxygen's sources
       related to internationalization (i.e. the translator classes), to
       avoid duplication of information (i.e. doc/language.doc is now
       generated) and to generate reports about the status of the translations
       (e.g. missing methods).
+ ADD: Added Italian translator update sent by Alessandro Falappa.
       Also included updates for Russian and added support for
       Danish (thanks to Erik Søe Sørensen)
+ ADD: Added support patch for "KBD" tags and HTML tags (thanks to Albin Wu).
+ ADD: Added man patch by Patrick Ohly which allows to create freestyle
       man pages using \page and puts man page with non-default extension
       in the correct directory.
+ BUG: Fixed a bug in the LaTeX output generation (empty lists).
+ BUG: Doxygen can now distiguishing f(const A) from f(const B)
       even though they match from a syntactical point of view.
+ BUG: A template base class that is actually an inherited template
       argument of the derived class is no longer shown in the output
       indices and hierarchies.
+ BUG: TOC_EXPAND could result in a broken tree view
       (patch by Alexandr Chalpanov).
+ BUG: If a base class had member names which has the same name as enumerator
       values in a derived class, the enumerator values did not show up in
       the documentation (thanks to John Harris for reporting this).
------------------------------------------------------------------------
Enjoy,
  Dimitri

Re: [Doxygen-users] w2k compiling failed

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

On Fri, May 18, 2001 at 03:59:26PM -0700, Peter Thieß wrote:
> I am using doxygen quite a bit among Win NT 4.0, now I started using w2k
> professinell and doxygen refused to work proper. I looked into the FAQ but
> did not find anything about w2k.
> I am currently using version 1.2.5 of doxygen.

Doxygen should work on w2k just like it does on NT. 

> 
> As a seccond step I tried (for the first time) to compile the actual tarball
> version but it failed, see appended file - I would be glad for any hints
> resolving this.

For those that do not read images:
Your error was:

bison: Bad address

This error is caused by bison not being able to find a /tmp dir (yes the
error message is not very helpful). To fix this start a bash shell 
(included with cygwin) and type "mkdir /tmp". After that all should be 
fine again.

> Further more I'd be intrested in experiences using doxygen among windows
> 2000.
> 
> The only output doxygen generates at my w2k installation is the following:
> Searching for include files...
> Searching for example files...
> Searching for images...
> Searching for files to exclude
> Reading input files...
> 
> It seams that doxygen doesn't find anything to do on W2K, whereas it did on
> NT 4.0 ....

I'm sure this is some configuration issue.

Regards,
  Dimitri

[Doxygen-users] w2k compiling failed

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

I am using doxygen quite a bit among Win NT 4.0, now I started using w2k
professinell and doxygen refused to work proper. I looked into the FAQ but
did not find anything about w2k.
I am currently using version 1.2.5 of doxygen.

As a seccond step I tried (for the first time) to compile the actual tarball
version but it failed, see appended file - I would be glad for any hints
resolving this.

Further more I'd be intrested in experiences using doxygen among windows
2000.

The only output doxygen generates at my w2k installation is the following:
Searching for include files...
Searching for example files...
Searching for images...
Searching for files to exclude
Reading input files...

It seams that doxygen doesn't find anything to do on W2K, whereas it did on
NT 4.0 ....

Thanks to all, esp. Dimitri for the great work done developing doxygen and
for the help anyway

Peter

[Doxygen-users] grouping patches

[Patrick O. <Pat...@pa...>]

Hi all,

here are patches for doxygen that enhance (or so I hope) the
grouping capabilities:

There are now three commands to define a group:
  \defgroup name title
  \addtogroup name [title]
  \weakgroup name [title]

\defgroup must be used exactly once for a group, so you should
provide a title. Without the title you will get a warning and
doxygen will use the name as title (this is the old behaviour).

/** \addtogroup name */ can be used to add documentation or
members to a group (as in 1.2.7), but the group is created if
it doesn't exist yet. You can provide the title later
with another block:
/**
 * \addgroup name title
 * documentation
 */

Setting different titles will trigger a warning without overwriting
the title once more.

\weakgroup is exactly the same as \addtogroup, but if a member
was put into such a group with \weakgroup name @{ @} and into
another group with \[def|addto]group @{ @}, then it will be
placed into the other group without issuing a warning.

Actually there is a four-level hierarchy for grouping with
(from strongest to weakest) \ingroup, \defgroup, \addtogroup,
\weakgroup. You will get warnings when putting members into
groups with commands of the same level, but only when you really
document this member. This will not trigger a warning and put
variable a into Group1:

/** \addtogroup Group1 */
/*@{*/
/** this is the real group */
extern int a;
/*@}*/

/** \addtogroup Group2 */
/*@{*/
extern int a;
/*@}*/

Member groups (i.e. grouping of struct/class members) works as
before.

I have attached the diff and an example that uses the new
features and also triggers some warnings on purpose.

Bye, Patrick
-- 
// pallas  GmbH  ............  Patrick Ohly  .............
   Hermuelheimer Str. 10       Software-Engineer
   D-50321 Bruehl, Germany     po...@pa...
   fax +49-(0)2232-1896-29     phone  +49-(0)2232-1896-30 
   http://www.pallas.com 
..........................................................

RE: [Doxygen-users] MACRO Question

[Philippe L. <Ph...@gm...>]

dav...@ca... wrote:
>>>
Hi, 
Is it possible to hide in the doxygen documentation the body of a C macro ? 

Example: 

I define the following macro: 

#define MAX(a, b) (((a)>(b))?(a):(b)) 

with the doxygen comment: 

/*! \def MAX(a,b) 
    \brief A macro that returns the maximum of \a a and \a b. 
*/ 
  

I would like to have the following result: 

Defines 

#define  MAX(a, b) 
  A macro that returns the maximum of a and b. More...
<<<

I found a solution, but it behaves rather strangely.
The solution:
You must use the \hideinitializer command.
The bug (or strange behaviour):
It doesn't work with \def.

In other words, 

/*!
    \hideinitializer
    \def MAX(a,b)
    \brief A macro that returns the maximum of \a a and \a b.
*/ 

doesn't work, while

/*!
    \hideinitializer
    \brief A macro that returns the maximum of \a a and \a b.
*/ 

works...
Note that if you put the comment just before the macro, you don't need to
put the \def. It is redundant and leads to risk of inconsistencies (often
programmers change code, but forget to change comments).

Another strange behaviour, but acceptable:

#define MAX(a, b) (((a)>(b))?(a):(b)) 

produces a definition line with the value on the same line, while

#define MAX(a, b) \
    (((a)>(b))?(a):(b)) 

gives a definition, with the value in a grey box prefixed by "Value:".

Regards.

PS.: Dimitri, I have done a little error chase in the documentation, as
promised for a long time. I have to do a last file, and I will send you the
result.

-- 
--._.·´¯`·._.·´¯`·._.·´¯`·._.·´¯`·._.·´¯`·._.·´¯`·._.--
Philippe Lhoste (Paris -- France)
Professional programmer and amateur artist
http://jove.prohosting.com/~philho/
--´¯`·._.·´¯`·._.·´¯`·._.·´¯`·._.·´¯`·._.·´¯`·._.·´¯`--

Sent through GMX FreeMail - http://www.gmx.net

[Doxygen-users] MACRO Question

[<dav...@ca...>]

Hi,

Is it possible to hide in the doxygen documentation the body of a C
macro ?

Example:

I define the following macro:

#define MAX(a, b) (((a)>(b))?(a):(b))

with the doxygen comment:

/*! \def MAX(a,b)
    \brief A macro that returns the maximum of \a a and \a b.
*/


I would like to have the following result:

Defines

     #define  MAX(a, b)
       A macro that returns the maximum of a and b. More...

Thanks,

David

RE: [Doxygen-users] Bug

[Trevor R. <Tre...@pe...>]

Hi,
 
I imagine your problem is due to Doxygen not being configured to preprocess
your source as you would expect.  I use macros extensively with Doxygen (not
because I'm evil, but because there's no other way to write portable code)
without any problems.  But before I did everything I mention below, Doxygen
was very confused.
 
Are you sure that you have preprocessing (ENABLE_PREPROCESSING = YES) and
macro expansion (MACRO_EXPANSION = YES) enabled, but EXPAND_ONLY_PREDEF =
NO?  If so, the next step is to make sure Doxygen sees the definition of
your macro.  In your example below, everything should work as is.  If you
#include the file containing the macro definition, you need to make sure
that SEARCH_INCLUDES = YES, and that INCLUDE_PATH contains the path to the
file.  (I don't think Doxygen even complains if it can't find a #included
file.)  If you don't #include the definition in every file that needs it
(remember that Doxygen treats each file individually) and don't want to
(i.e. you rely on other consumers to #include your headers in a certain
order), you can use the PREDEFINED setting.
 
Hope that helps,
Trevor
-----Original Message-----
From: Shane Stevens [mailto:sh...@bl...]
Sent: Monday, May 14, 2001 8:53 PM
To: Doxygen-Users
Subject: [Doxygen-users] Bug


Hi,
I have found a nasty little bug which has lost me a LOT of time.
 
Symptom: Sometimes all the member documentation disappears for certain
classes.  So if I put a ';' after a macro use it all works,  the problem is
it is perfectly legal c/c++ NOT to have a semi colon, and all compiler
pre-processors can handle not having one, and hence I use it when I want a
macro to look like a function call, and other times I use it for pure
pre-processor replacement.  I have hundreds of files without a ';', so to go
back and add one is painful, and incorrect.
Cause: Using macros, inside a class, and not putting a semi-colon on the end
of its use.
Example:
Fail example:
 
#define MACRO()      public:
class blah
{
       MACRO()
       public:
       blah(){};
       ~blah(){};
};
 
Work example:
 
#define MACRO()      public:
class blah
{
       MACRO();
       public:
       blah(){};
       ~blah(){};
};
 
Has anyone else seen this problem before?  Can it be fixed easily?
 
Thanks,
Shane
 


  _____  

 <http://staff.bluetongue.com/~shane/> Shane Stevens
Lead Programmer
 <http://www.bluetongue.com/> bluetongue

  _____  

 

[Doxygen-users] Bug

[Shane S. <sh...@bl...>]

Hi,
I have found a nasty little bug which has lost me a LOT of time.

Symptom: Sometimes all the member documentation disappears for certain
classes.  So if I put a =91;=92 after a macro use it all works,  the prob=
lem is
it is perfectly legal c/c++ NOT to have a semi colon, and all compiler
pre-processors can handle not having one, and hence I use it when I want =
a
macro to look like a function call, and other times I use it for pure
pre-processor replacement.  I have hundreds of files without a =91;=92, s=
o to go
back and add one is painful, and incorrect.
Cause: Using macros, inside a class, and not putting a semi-colon on the =
end
of its use.
Example:
Fail example:

#define MACRO()      public:
class blah
{
       MACRO()
       public:
       blah(){};
       ~blah(){};
};

Work example:

#define MACRO()      public:
class blah
{
       MACRO();
       public:
       blah(){};
       ~blah(){};
};

Has anyone else seen this problem before?  Can it be fixed easily?

Thanks,
Shane

  _____

Shane Stevens <http://staff.bluetongue.com/~shane/>
Lead Programmer
bluetongue <http://www.bluetongue.com/>
  _____

[Doxygen-users] EXPAND_AS_DEFINED and Poor Mans Inheritance

[Peter S. <pet...@hu...>]

Hello all

I one project, I'm forced to use C. I try to get some struct reuse and
sort of object inheritance with the following contruct:

//------ begin of example

#define BASECLASS \
    int         aMember;        /**< Members Doc */ \
    /* END OF BASECLASS */

/**
 * This is the base class
 */
typedef struct BaseClass {
    BASECLASS
} BaseClass;

/**
 * This is a derived class
 */
typedef struct DerivedClass {
    BASECLASS
    int         additionalMember;   /**< also documented */
} DerivedClass;

//------ end of example

To get the documentation right, I'm using the MACRO_EXPANSION,
EXPAND_ONLY_PREDEF and EXPAND_AS_DEFINED = BASECLASS macros. But that
works only halfway: the 'aMember' appears in the documentation if
HIDE_UNDOC_MEMBERS is not set, but without documentation.

It seems that the doxygen comments inside my macro BASECLASS are
swallowed during the preprocessing stage. I'd like to happen the macro
expansion first and then the extraction of the comments...

Is there a way to make this work?

Regards, Peter
-- 
    _   _        Peter Steiner <pet...@hu...>
  / /_/ /        Hug-Witschi AG <http://www.hugwi.ch/>
 /  _  /         Electronic Engineering
/_/ /_/  _   _   Industriestrasse 12
   / / / / / /   CH-3178 Boesingen
  / /_/ /_/ /    Tel  +41 31 740 44 44
 /_ _ _ _ _/     Fax  +41 31 740 44 45

[Doxygen-users] documentation order and bibliography

[Angela S. <sta...@sa...>]

Hi all.

I hope someone can help me to tell Doxygen to change documentation order
such that my "documentation only" file is placed before any other. I've
tried to use the \mainpage command, but the result is not what I wanted.

I don't want to specify the order of the whole documentation but only
place my introduction file at the begin.

Also, I need to cite some papers and I'd like to use the latex \cite
command. Can I? Or is there a similar way to provide some bibtex entry
and refer to it?

Thanks,
     Angela.

Re: [Doxygen-users] Template problem

[Hendrik S. <Do...@HS...>]

"Dimitri van Heesch" <di...@st...> wrote:

> On Sat, May 12, 2001 at 01:46:06AM +0200, Hendrik Schober wrote:
> > Anyone out there?
> > (If one does some template meta programming inheriting from
> > a template parameter is pretty common and having all these
> > little unknown/undocumented dummy classes cluttering the
> > documentation really _is_ an annoying problem.)
> 
> I agree (and am working on a fix).

  Thanks!

> Regards,
>   Dimitri

  Schobi

Re: [Doxygen-users] Template problem

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

On Sat, May 12, 2001 at 01:46:06AM +0200, Hendrik Schober wrote:
> Anyone out there?
> (If one does some template meta programming inheriting from
> a template parameter is pretty common and having all these
> little unknown/undocumented dummy classes cluttering the
> documentation really _is_ an annoying problem.)

I agree (and am working on a fix).

Regards,
  Dimitri

Re: [Doxygen-users] Template problem

[Hendrik S. <Do...@HS...>]

Anyone out there?
(If one does some template meta programming inheriting from
a template parameter is pretty common and having all these
little unknown/undocumented dummy classes cluttering the
documentation really _is_ an annoying problem.)

Schobi


"Ren=E9 Gutschmidt" <r.g...@ca...> wrote:

> Hi !
>
> I have a problem in the following example.
> Example:
>
> template <typename XYZ >
> class ABC : virtual public XYZ { };
>
> Problem:
>
> I have a class template that is derived from its template parameter "XY=
Z".
> Doxygen makes an error and recognizes the 'XYZ' parameter as a real kno=
wn
> class. That's wrong because 'XYZ' is a wild card - only after the objec=
t of
> ABC type is created the type of the template will be known.
> Therefore it would be better, if Doxygen omits the documentation of the
> template parameter 'XYZ '.
>
> MfG
> Ren=E9

Re: [Doxygen-users] RE: Suggestion: Eliminate "Static..." in Doxygen

[Jonathan B. <bop...@ne...>]

I would also like to have the tool group the static (private) from the rest
(public).

thanks

Stephen Goudge wrote:
> 
> > -----Original Message-----
> > From: Derek Kusiak [mailto:de...@ne...]
> > Sent: 04 May 2001 18:53
> > To: do...@xe...
> > Subject: Re: Suggestion: Eliminate "Static..." in Doxygen
> >
> >
> > One more comment: I'm not necessarily suggesting the default
> > behavior of Doxygen be changed. I'm just suggesting that the
> > -option- to not generate separate groups for statics be available.
> > For example, a flag could be added to the configuration
> > (GROUP_STATICS=No perhaps?).
> >
> 
> I would like to add my vote for that addition to the config file (especially as
> I've just been asked about that by a colleague).
> 
> Regards,
> Stephen Goudge
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxygen-users


NetZero Platinum
No Banner Ads and Unlimited Access
Sign Up Today - Only $9.95 per month!
http://www.netzero.net

[Doxygen-users] Problem Report: Hyperlinks to Local References Create Additional Tree Controls

[Scott H. <sc...@ha...>]

Problem:
If you set "GENERATE_TREEVIEW=YES" and have a page with local references 
(\ref), when HTML is generated the links are relative to the index.html 
page rather than to the local page.  When you click on the resulting 
link, you get an extra tree control instead of jumping to that link.

Test Case:
Below, I've attached a simple file that reproduces the problem.  Save 
the contents as foo.txt.  Generate a default Doxyfile and alter the 
following settings:
   INPUT                  = test.txt
   GENERATE_TREEVIEW      = YES

Run Doxygen and launch html/index.html.  Click on either of the 
hyperlinks in section Two.  Every time you click on a link in section 
Two, an additional tree control will be displayed.

Analysis:
The index page is really a frameset containing a "treefrm" frame to 
display the tree control, and a "basefrm" frame to display the main.html 
page.  The hyperlinks in section Two are defined relative to index.html 
rather than to main.  (e.g. <a href="index.html#one">One</a>)  Clicking 
on this link causes a new index.html frameset to be nested within the 
"basefrm" frame.

Editing the main.html file and changing the links to be relative to the 
page displayed in the "basefrm" frame instead of the frameset fixes the 
problem (e.g. <a href="main.html#one">One</a>)

I'm guessing the problem is not in HtmlGenerator, but in the code that 
calls writeSectionRef() and writeSectionRefItem().  They must be passing 
in the name of the frameset ("index.html") rather than the name of the 
page currently displayed in the basefrm.

Fix:  To Be Determined...

---------------------test.txt-------------------------
/*!
\mainpage Tree Test

\section one One
This is section one.

\section two Two
This is section Two.  It has a reference to section \ref one, and a 
reference to section \ref three.

\section three Three.
This is section Three.
*/

RE: [Doxygen-users] C macro ARGS

[Michael S. <Mic...@de...>]

Hi!

Which MACRO/PREDEF configurations do you use?

We use some similiar ARGS macros and have them (together with othe macros we
wish to be expanded by doxygen) set in the PREDEFINED configuration setting:

PREDEFINED = "ARGS0(a)=(a)" "ARGS1(t,a)=(t a)" "ARGS2(t,a,u,b)=(t a,u b)"

and so on. This works well for us together with:

MACRO_EXPANSION = "YES"
EXPAND_ONLY_PREDEF  = "YES"

Ciao Mick
> -----Original Message-----
> From:	Emanuele Olivetti [SMTP:oli...@it...]
> Sent:	Friday, May 11, 2001 10:50 AM
> To:	Doxygen mailing list
> Subject:	[Doxygen-users] C macro ARGS
> 
> Hi,
> is there a way to let doxygen understand the use of the ARGS C macro,
> to allow the correct cross-referencing?
> 
> Example:
> Doxygen 1.2.6 produced a funny cross-reference to ARGS in the line:
> 
> static node_ptr make_quantifiers ARGS((node_ptr, add_ptr));
> 
> pointing to :
> 
> "Function Documentation
>  EXTERN char* get_text ARGS ( (string_ptr str) ) 
>  EXTERN string_ptr find_string ARGS ( (char *) ) 
>  EXTERN void init_string ARGS ( (void) ) "
> 
> and no cross-reference associated to the function "make_quantifiers".
> 
> 
> Thanks a lot
> 
> 					Emanuele
> 					Olivetti
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Disabled and reject

[áÌÅËÓÁÎÄÒ þÅÌÐÁÎÏ× <ca...@ma...>]

I have been disabled, internal address 193.125.68.26.
All attapts to send email to dox...@li... rejected.
I try to enable, but I forget password.
"Email my password to me" don't mail this password to me. How can I got password and enable list delivery?
Thanks, Alexandr Chelpanov, ca...@cr...

[Doxygen-users] C macro ARGS

[Emanuele O. <oli...@it...>]

Hi,
is there a way to let doxygen understand the use of the ARGS C macro,
to allow the correct cross-referencing?

Example:
Doxygen 1.2.6 produced a funny cross-reference to ARGS in the line:

static node_ptr make_quantifiers ARGS((node_ptr, add_ptr));

pointing to :

"Function Documentation
 EXTERN char* get_text ARGS ( (string_ptr str) ) 
 EXTERN string_ptr find_string ARGS ( (char *) ) 
 EXTERN void init_string ARGS ( (void) ) "

and no cross-reference associated to the function "make_quantifiers".


Thanks a lot

					Emanuele
					Olivetti

Re: [Doxygen-users] Documentation only.

[Scott H. <sc...@ha...>]

Prikryl,Petr wrote:

> Angela Stazzone wrote...
> 
>> And should I use a special suffix for these kind of files?
> 
> The documentation-only files are used also for creating
> Doxygen's documentation.  Have a look at doc subdirectory
> inside the Doxygen directory.  The files use the .doc extension,
> but it does not matter.  You can give it whatever extension, 
> but the input files have to be determined via options 
> inside your Doxyfile.

The technique I've been using is to put a "Readme.txt" file in the same 
folder containing the Doxyfile (and then I add "*.txt" or "Readme.txt" 
to the input file list in the Doxyfile).  Not everyone here is using 
Doxygen, but it's pretty easy to put together descriptions that format 
well with Doxygen, yet are human-readable -- especially since Doxygen is 
really good about automatically defining hyperlinks where it can.  The 
Readme.txt file contains the Doxygen @mainpage directive and provides 
overview information for the project, build/install instructions, and 
anything else that seems appropriate for the main page. 

That particular file name was chosen because when someone stumbles 
across a file called "Readme.txt", they probably have a pretty good idea 
what to find there.

The information before the "/*!" is not included in the extracted 
documentation, so that's a good place to inform the reader that Doxygen 
exists, where to find it, and how to use it to extract the documentation 
for this project.

Here's an example of the Readme.txt file.  I'm including it mainly to 
demonstrate that it's pretty easy to have text that's both Human- and 
Doxygen-readable. 

Comments/suggestions/criticisms are welcome.

--------------------cut here-----------------------
The design documentation for this project is included as comments in
the code.  The doxygen tool (http://www.doxygen.org/) can be used to
extract this documentation into either a browsable web or an RTF
document.  The doxygen installers are available at
http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc.

Once you have doxygen installed, just run "doxygen" from this
directory.  Then view either html\index.html or rtf\refman.rtf.

/*! \mainpage CPriority

  \todo
   Add references for Linux and Windows pages re: process
   priority manipulation.

\section ref References

\section intro Introduction
This class provides a simple, platform independent way for Windows or
Linux process to adjust their priority.

\subsection usage Usage
Say you have an application program whose priority you want to
lower.  You'd do something like this:
  <pre>
      CPriority::TheInstance().AdjustPriority("Low");
  </pre>

\section nt_vs_linux NT vs. Linux
Under Windows NT, you can't alter the priority of a process direct;
rather you specify a priority class (Low, Medium, High, Realtime).
Linux doesn't support these priority classes, but lets you specify
a maximum priority (-20..+20, the lower the number, the higher the
priority).  In an attempt to provide comparable functionality in a
comparable way, the parameter to AdjustPriority is one of the
following values:
   - "Low",
   - "Medium", or
   - "High"

For a Windows NT process, this is mapped directly to a priority
class.  For Linux, "Low" = +10, "Medium" = 0, and "High" = -10.

Note that for Linux, only the superuser is allowed to raise a
process priority (lower number).

\section unit_testing CPriority Unit Testing (TEST.EXE)
The unit test for CPriority is defined in test.cpp.  See comments in
that file for more information.

\section errors When Things Go Wrong
etc. etc. etc.

\todo
   Test on Linux

*/

RE: [Doxygen-users] Documentation only.

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

Hi Angela,

Angela Stazzone wrote...
>
> Is there any particular way to write a file containing documentation
> only, or it is sufficient to write the documentation between "/*!
> ...*/"?

It is enough to put your documentation content between /*!
and */

> And should I use a special suffix for these kind of files?

No.

The documentation-only files are used also for creating
Doxygen's documentation.  Have a look at doc subdirectory
inside the Doxygen directory.  The files use the .doc extension,
but it does not matter.  You can give it whatever extension, 
but the input files have to be determined via options 
inside your Doxyfile.

Petr

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

[Doxygen-users] RE: Suggestion: Eliminate "Static..." in Doxygen

[Stephen G. <ste...@pi...>]

> -----Original Message-----
> From: Derek Kusiak [mailto:de...@ne...]
> Sent: 04 May 2001 18:53
> To: do...@xe...
> Subject: Re: Suggestion: Eliminate "Static..." in Doxygen
>
>
> One more comment: I'm not necessarily suggesting the default
> behavior of Doxygen be changed. I'm just suggesting that the
> -option- to not generate separate groups for statics be available.
> For example, a flag could be added to the configuration
> (GROUP_STATICS=No perhaps?).
>

I would like to add my vote for that addition to the config file (especially as
I've just been asked about that by a colleague).

Regards,
Stephen Goudge

[Doxygen-users] Documentation only.

[Angela S. <sta...@sa...>]

Hi all.

Is there any particular way to write a file containing documentation
only, or it is sufficient to write the documentation between "/*!
...*/"?
And should I use a special suffix for these kind of files? I guess it
will be something like ".dox".

Thanks,
     Angela.

RE: [Doxygen-users] ordered list and restriction tag additions

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

There is the order list construction.
While the unordered list is created in the following way...

 - first unnumbered item
 - second unnumbered item
 - third unnumbered item

... the ordered list is created this way in Doxygen:

 -# first numbered item
 -# second numbered item
 -# third numbered item

BTW, the HTML syntax for lists is translated into all
outputs by Doxygen, not only into HTML output.
Some people would also advice RTFM ;-)

Concerning the proposed \restriction... There is the \bug
command in Doxygen and the trBugAndLimitations()
method in translator which generates "Bugs and limitations"
for the list of \bug commands.  In my opinion, bugs may
be slightly different from limitations.  So, I think that the
request for \limitation (or the \restriction) is reasonable.

Petr

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

> -----Original Message-----
> From:	dr...@ca... [SMTP:dr...@ca...]
> Sent:	Wednesday, May 09, 2001 6:01 PM
> To:	dox...@li...
> Subject:	[Doxygen-users] ordered list and restriction tag additions
> 
> 
> Hi,
> 
> Is there any way to have ordered list using doxygen tags without html?
> If there isn't, could Dimitri add a  "\oli" tag  which would give a
> correct
> ordered list in all output formats?
> 
> Also, would-it be possible to add a \restrictions command? I know I can
> use
> alias
> but I'm trying to be as much independent from special tags as possible. I
> just think
> that a function's restriction is between \note, \warning and \todo.
> 
> 
> Thanks.
> 
> 
> //-----------------------------------
> // Denis Ricard,  IBM Canada
> //   dr...@ca...
> //   416 - 448 - 4124
> //-----------------------------------
> 
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] doxygen-1.2.7solaris build fails

[<sun...@ex...>]

Hello,

I am trying to install doxygen on solaris-g++. The build fails at building
qxml.cpp platform.  The environment details and build failure log is
attached.

Anything I am missing or doing incorrectly?

Thank You,
sunil

[tekgp8:doxygen-1.2.7] uname -a
SunOS tekgp8 5.5.1 Generic_103640-32 sun4u sparc SUNW,Ultra-Enterprise
[tekgp8:doxygen-1.2.7] gcc -version
gcc: unrecognized option `-version'
gcc: No input files
[tekgp8:doxygen-1.2.7] gcc -ver
gcc: unrecognized option `-ver'
gcc: No input files
[tekgp8:doxygen-1.2.7] gcc -dumpversion
2.9-redhat-980810
[tekgp8:doxygen-1.2.7] make -version
GNU Make version 3.75-redhat-980810, by Richard Stallman and Roland McGrath.
Copyright (C) 1988, 89, 90, 91, 92, 93, 94, 95, 96
        Free Software Foundation, Inc.
This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.

Report bugs to <bug...@pr...>.

[tekgp8:doxygen-1.2.7] make 
/tools/gcc-2.8.1/bin/make -C qtools
/tools/gcc-2.8.1/bin/make -f Makefile.qtools    all
g++ -c -DQT_NO_CODECS -DQT_LITE_UNICODE -Wall -W -O2 -I. -o
../objects/qxml.o qxml.cpp
qvaluelist.h: In method `void QValueListPrivate<QMap<QString,QString>
>::remove(const class QMap<QString,QString> &)':
qvaluelist.h:376:   instantiated from `QValueList<QMap<QString,QString>
>::remove(const QMap<QString,QString> &)'
qvaluestack.h:57:   instantiated from `QValueStack<QMap<QString,QString>
>::pop()'
qxml.cpp:513:   instantiated from here
qvaluelist.h:276: no match for `QMap<QString,QString> & == const
QMap<QString,QString> &'
qcstring.h:319: candidates are: operator ==(const QCString &, const QCString
&)
qcstring.h:322:                 operator ==(const QCString &, const char *)
qcstring.h:325:                 operator ==(const char *, const QCString &)
qstring.h:270:                 operator ==(char, QChar)
qstring.h:275:                 operator ==(QChar, char)
qstring.h:280:                 operator ==(QChar, QChar)
qstring.h:745:                 operator ==(const QString &, const QString &)
qstring.h:752:                 operator ==(const QString &, const char *)
qstring.h:758:                 operator ==(const char *, const QString &)
make[2]: *** [../objects/qxml.o] Error 1
make[1]: *** [all] Error 2
make: *** [all] Error 2
[tekgp8:doxygen-1.2.7] 


Sunil K Khiani
Tektronix, Inc. - MBD
IP Flow Monitoring Group
P.O. Box 500, M/S 50-488
Beaverton, OR 97077 
Phone : 1.503.627.4121
Fax   : 1.503.627.6710
email : sun...@te...

Re: [Doxygen-users] ordered list and restriction tag additions

[Ryan T. S. <ry...@ho...>]

http://www.stack.nl/~dimitri/doxygen/lists.html#lists


By putting a number of column-aligned minus signs at the start of a
line, a bullet list will automatically be generated. Numbered lists can
also be generated by using a minus followed by a hash. Nesting of lists
is allowed 



* dr...@ca... <dr...@ca...> [09/05/2001 09:09]:
> 
> Hi,
> 
> Is there any way to have ordered list using doxygen tags without html?
> If there isn't, could Dimitri add a  "\oli" tag  which would give a correct
> ordered list in
> all output formats?
> 
> Also, would-it be possible to add a \restrictions command? I know I can use
> alias
> but I'm trying to be as much independent from special tags as possible. I
> just think
> that a function's restriction is between \note, \warning and \todo.
> 
> 
> Thanks.
> 
> 
> //-----------------------------------
> // Denis Ricard,  IBM Canada
> //   dr...@ca...
> //   416 - 448 - 4124
> //-----------------------------------
> 
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxygen-users

-- 
Ryan T. Sammartino
http://members.home.net/ryants/
Since we have to speak well of the dead, let's knock them while they're alive.
		-- John Sloan