doxygen-users — List for users of doxygen

Re: [Doxygen-users] Doxygen-1.2.8 in CVS

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

1)
I use doxygen-1.2.8 and get a parameter list without an explicit "\return"
command. This doesn't happen in doxygen-1.2.7-20010524. I refer to
doxygen_docs/html/class_class_list.html, this contains:

int ClassList::compareItems(GCI item1,
                            GCI item2)

   Parameters:
          item1
          item2

2)
I cannot compile doxywizard (CVS version 1.2.8):

gmake[2]: Entering directory `/home/jens/Texte/doxygen/test/addon/doxywizard'
g++ -c -pipe -DDOXYWIZARD -Wall -W -O2 -DNO_DEBUG -I/home/jens/Texte/meshgen/qt-x11-free-3.0.0-beta1/include -o obj/doxywizard.o doxywizard.cpp
doxywizard.cpp: In function `bool saveConfig(QString)':
doxywizard.cpp:101: no matching function for call to `Config::writeTemplate (QFile *, const bool &)'
config.h:476: candidates are: void Config::writeTemplate(QFile *, bool, bool)
doxywizard.cpp: In method `ConfigFile::ConfigFile(QWidget * = 0)':
doxywizard.cpp:361: warning: `enum InputString::StringMode sm' might be used uninitialized in this function
doxywizard.cpp:403: warning: `enum InputStrList::ListMode lm' might be used uninitialized in this function
gmake[2]: *** [obj/doxywizard.o] Error 1
gmake[2]: Leaving directory `/home/jens/Texte/doxygen/test/addon/doxywizard'
gmake[1]: *** [all] Error 2
gmake[1]: Leaving directory `/home/jens/Texte/doxygen/test/addon/doxywizard'
make: *** [all] Error 2

3)
I found
"Supports C++, Java, (Corba, Microsoft, and KDE-DCOP) Java, IDL and C sources"
in doc/features.doc (Jave occurs twice!). What's Corba or KDE-DCOP (is there
a relation to Java)?

4)
I attached a small patch which fixes some typos.

Regards,
Jens

[Doxygen-users] doxywizard

[<Tho...@t-...>]

still have the same problem
doxywizard segfaults on my rh7.1
i tried 1.2.7 and 1.2.8
so i think the problem is elsewhere

-t.

Re: [Doxygen-users] Re: files order

[Roberto B. <ba...@cs...>]

"Wagner, Victor" wrote:
> 
> You didn't mention which output you're using.  In HTML 'order' matters
> little.
> 
> Angela Stazzone wrote:
> ... if a class A derive from another class B, I want
> the documentation of A comes AFTER the documentation of B.

Hi Victor,

you right, in HTML this is not problematic.  But in, e.g.,
PDF versions that are meant to be printed this is a big problem.
For this kind of documents, I would like to influence Doxygen
about the order in which program elements are described.
As I said, I believe this is important for printed documentation.

Any hints on how we can achieve this?
All the best,

    Roberto

-- 
Roberto Bagnara
Computer Science Group
Department of Mathematics, University of Parma, Italy
http://www.cs.unipr.it/~bagnara/
mailto:ba...@cs...

[Doxygen-users] Doxygen-1.2.8 in CVS

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

Hi,

Another official release is out. Here is what has changed since last update:
--------------------------------------------------------------------------
+ BUG: Environment variables can now also be used for non-string values
       in the config file, like for example QUIET = $(QUIET_ON)
+ ADD: Stanislav Kudlac added support for Slovak language.
       Applied language updates for Croatian, Spanish, Czech, German &
       Russian.
+ BUG: Fixed a number of typo's in the docs (thanks to Philippe Lhoste &
       Jens Seidel).
+ BUG: Inheritance through typedefs within a namespace did not yield the
       correct inheritance diagram.
+ BUG: References to anchors in grouped members or pages were not
       correctly resolved.
+ BUG: Fixed a problem with argument matching for arguments that contained
       classes imported via a using declaration.
--------------------------------------------------------------------------
Enjoy,
  Dimitri

RE: [Doxygen-users] Re: files order

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

You didn't mention which output you're using.  In HTML 'order' matters
little.

-----Original Message-----
From: Angela Stazzone [mailto:sta...@sa...]
Sent: Thursday, 2001 May 31 12:33
To: doxygen
Subject: [Doxygen-users] Re: files order


Angela Stazzone wrote:

> Hi all,
>
> I'd like the doxygen documentation of my project to be in "logical"
> order; this means that if a class A derive from another class B, I want
> the documentation of A comes before the documentation of B.
> I tried to set to NO the SORT_MEMBER_DOCS tag, but the result is not
> what I want.
>
> Any suggestion?
>
> Thanks,
>             Angela.

I think I made a "little" mistake!

... if a class A derive from another class B, I want
the documentation of A comes AFTER the documentation of B.

Sorry!

Thanks,
   Angela.




_______________________________________________
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

[Doxygen-users] bug?

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

Hi all.

I think I've found a bug.

In pdf documentation in each detailed description of the overloaded
operator [] I have what follows:

] <return type> <class name>::operator[](<arguments>)

where the header of the method is not bold while all the others are
bold.

I get for example

] INLINE Generator& GenSys::operator[](size_t k)

Am I doing something wrong?

Thanks,
      Angela.

[Doxygen-users] 2 INLINE_SOURCES related problems

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

Hi,

I found a few problems in doxygen-1.2.7-20010524:

1) Doxyfile:
# The DOC_ABSPATH tag should be the absolute path to the directory where the
# documentation is located. If left blank the directory on the local machine
# will be used.

# The DOC_URL tag should be the absolute URL to the directory where the
# documentation is located. If left blank the absolute path to the
# documentation, with file:// prepended to it, will be used.

I don't wont to write the full path of the html directory into the config
file. According to the documentation, it's possible to leave these variables
empty. But doxygen uses "." instead of the full path, so I have to start
netscape from this directory. Can someone change this, so that doxygen uses
DOC_URL=file://<path-to-html>, DOC_ABSPATH=<path-to-html> in all files it
generates (search.cfg,...)?

2) If there's a comma separated list of pointers, e.g.
      QLineEdit *LEgriddx,*LEgriddy;
   the output contains
      QLineEdit*  LEgriddx
      QLineEdit * LEgriddy.
   Is it possible to remove the blank in the second line?

3) The order of the arguments of doxygen is important!
   "doxygen -s -g" creates Doxyfile, but "doxygen -g -s" creates a file
   "-s" (use "rm -- -s" to remove).

4,5) There are two INLINE_SOURCES related problems:

4)
test.h:

class test {
  void f();
};

void test::f()
// see: xyz
{
  return;
}

Doxyfile:

EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
INLINE_SOURCES         = YES
INPUT                  = test.h

The output is incomplete ("// see" is missing):

void test::f ( ) [private]

    00006       : xyz
    00007 {
    00008   return;
    00009 }

The same happens if I use "/* see: xyz */"!

5)
Tools.h:

long int min(long int, long int);
double min(double, double);

Tools.cpp:

#include "Tools.h"

long int min(long int a, long int b)
{
  if (a<b) return a; else return b;
}

double min(double a, double b)
{
  if (a<b) return a; else return b;
}

Doxyfile:

EXTRACT_ALL            = YES
INLINE_SOURCES         = YES
INPUT                  = Tools.cpp Tools.h

Tools_8h.html contains:
double min (double a,
            double b)
    00009 {
    00010   if (a<b) return a; else return b;
    00011 }

 long int min (long int a,
               long int b)

   <there's no source code here!>

The problem doesn't occur, if I use "INPUT=Tools.h Tools.cpp".

Regards,
Jens

[Doxygen-users] doxywizard on rh7.1

[<Tho...@t-...>]

hi there,

does anybody else encounter the prob that doxywizard 1.7
seg faults on rh7.1?
any solutions?

regards

-t.

RE: [Doxygen-users] Problem:Continuus does not like '-' in filena mes.

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

Hi,

We are in the process of switching to Continuus, so I asked the guy in
charge of the switch-over about this.  Here is his response:

"That is slightly incorrect.  The users problem below is that continuus has
this concept of a delimiter.  Thats how it versions objects.  For example,
you would have a psql project with versions psql-7.8 or psql-7.9.

Good news is this, when you first set up a repository, you can define what
the delimiter is to be.  So, what I have done is changed the delimter to the
semi-colon character (";").  I figure that is pretty safe.  Hence we would
have the project psql with version psql;7.8 and psql;7.9.

Now, according to the documentation, Continuus does not recommend changing
the delimiter in mid stream.  I am not sure what the ramifications are of
doing that.  But if the user below has a CM team that is willing to "try it
out" they could copy their CM database to a temporary one, change the
delimiter, and see if everything works.  I got the impression from the
continuus training class, that the reason to not change the delimiter was
for scripting purposes.  Say you have years of scripts lying around with the
delimter hard coded, then you are  going to have a major script
re-engineering project on your hands."

Hope this helps.

-Trevor

-----Original Message-----
From: Mar...@no... [mailto:Mar...@no...]
Sent: Friday, June 01, 2001 10:48 AM
To: dox...@li...
Subject: [Doxygen-users] Problem:Continuus does not like '-' in
filenames.


Hi all,

We use Continuus as version management system. So far so good.
...but it does NOT accept hyphens '-' in filenames to be checked in.
=> we cannot add the genereated documentation to vcs, as lot of files are
named like 'buf_stack_8h-source.html'.

Is there any workaround?
Any opinion about the possibility to change the filename generation inside
Doxygen?

We will definitely not drop Doxygen as there are some many nice things and
smart features included,
but this problems is a little bit annoying.

Anyway: Dimitri (and contributors), thanks for the great job.

Regards,
 Markus Lepper

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

Re: [Doxygen-users] Problem:Continuus does not like '-' in filenames.

[Jac G. <ja...@ma...>]

>- for any x in {p: p is a known programming language}
>    write a program in x that changes - to _

This won't help: the resulting filenames won't correspond to the 
generated hotlinks anymore (apart from the small chance that it might 
not be unique anymore).

Dimitri, maybe you can change the file naming scheme so that instead of 
merging file names with "_" or "-", they are (optionally) put in 
separate directories (i.e. merge file names with "/" or "\\" depending 
on operating system and creating directories on the fly with the 
files)? Shouldn't be too hard I guess, and it would improve html output 
a lot: directories would be smaller so that it doesn't take ages to 
read a directory (in some filesystems the performance decreases 
dramatically when the directory grows above a certain number of files), 
and less chance of name collisions. 

It may even be possible (later?) to generate smaller documentation 
because the HTML hotlinks can have relative paths instead of the entire 
file names.

===Jac

Re: [Doxygen-users] Problem:Continuus does not like '-' in filenames.

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

> We use Continuus as version management system. So far so good.
> ...but it does NOT accept hyphens '-' in filenames to be checked in.
> => we cannot add the genereated documentation to vcs, as lot of files are
> named like 'buf_stack_8h-source.html'.
> 
> Is there any workaround?

Sure:

- complain to Continuus

- for any x in {p: p is a known programming language}
    write a program in x that changes - to _

- rename files by hand


> Any opinion about the possibility to change the filename generation inside
> Doxygen?
> 

If I were Dimitri or any of the contributors, I'd say "no", frankly.  I
wouldn't throw hacks in my code to cover for the stupidity of others
unless it affected, like, everyone.  That's my opinion. 


-- 
Ryan T. Sammartino
http://members.home.net/ryants/
The years of peak mental activity are undoubtedly between the ages of four
and eighteen.  At four we know all the questions, at eighteen all the answers.

RE: [Doxygen-users] Problem:Continuus does not like '-' in filenames.

[David C. <dav...@br...>]

You could use SHORT_NAMES:

# If the SHORT_NAMES tag is set to YES, doxygen will generate much
shorter=20
# (but less readable) file names. This can be useful is your file
systems=20
# doesn't support long names like on DOS, Mac, or CD-ROM.

SHORT_NAMES            =3D YES

I've only ever seen letters and numbers in the short names generated
this way.

David

> -----Original Message-----
> From: Mar...@no... [mailto:Mar...@no...]
> Sent: Friday, June 01, 2001 10:48 AM
> To: dox...@li...
> Subject: [Doxygen-users] Problem:Continuus does not like '-' in
> filenames.
>=20
>=20
> Hi all,
>=20
> We use Continuus as version management system. So far so good.
> ...but it does NOT accept hyphens '-' in filenames to be checked in.
> =3D> we cannot add the genereated documentation to vcs, as lot=20
> of files are
> named like 'buf_stack_8h-source.html'.
>=20
> Is there any workaround?
> Any opinion about the possibility to change the filename=20
> generation inside
> Doxygen?
>=20
> We will definitely not drop Doxygen as there are some many=20
> nice things and
> smart features included,
> but this problems is a little bit annoying.
>=20
> Anyway: Dimitri (and contributors), thanks for the great job.
>=20
> Regards,
>  Markus Lepper
>=20
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxygen-users
>=20

[Doxygen-users] Problem:Continuus does not like '-' in filenames.

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

Hi all,

We use Continuus as version management system. So far so good.
...but it does NOT accept hyphens '-' in filenames to be checked in.
=> we cannot add the genereated documentation to vcs, as lot of files are
named like 'buf_stack_8h-source.html'.

Is there any workaround?
Any opinion about the possibility to change the filename generation inside
Doxygen?

We will definitely not drop Doxygen as there are some many nice things and
smart features included,
but this problems is a little bit annoying.

Anyway: Dimitri (and contributors), thanks for the great job.

Regards,
 Markus Lepper

Re: [Doxygen-users] problem with inheritance and namespaces

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

On Wed, May 30, 2001 at 03:34:31PM +0200, Pablo Alvarado wrote:
> Hi all!
> 
> I have the following problem, and I think is a bug:
> 
> --------------------------------------------------
> 
> namespace ns { // #####
> 
>   /**
>    * the parent template class 
>    */
>   template <class T>
>     class A {
>   };
>   
>   /**
>    * alias for A<int>
>    */
>   typedef A<int> iA;
>   
>   /**
>    * inherited class
>    */
>   class B : public iA {
>   };
>   
> } // #####
> 
> ---------------------------------------------------
> 
> If I generate the documentation for this code, the template class B will
> not be "connected" with the class A 
> 
> If the lines marked with "// #####" are removed, then everything is fine
> and the inheritance tree is build correctly:  class B inherits from A.
> 
> Does anyone knows a workaround for this, or can this be fixed?

This is a bug indeed. I'm preparing a fix at the moment.

Regards,
  Dimitri

[Doxygen-users] Re: files order

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

Angela Stazzone wrote:

> Hi all,
>
> I'd like the doxygen documentation of my project to be in "logical"
> order; this means that if a class A derive from another class B, I want
> the documentation of A comes before the documentation of B.
> I tried to set to NO the SORT_MEMBER_DOCS tag, but the result is not
> what I want.
>
> Any suggestion?
>
> Thanks,
>             Angela.

I think I made a "little" mistake!

... if a class A derive from another class B, I want
the documentation of A comes AFTER the documentation of B.

Sorry!

Thanks,
   Angela.

[Doxygen-users] files order

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

Hi all,

I'd like the doxygen documentation of my project to be in "logical"
order; this means that if a class A derive from another class B, I want
the documentation of A comes before the documentation of B.
I tried to set to NO the SORT_MEMBER_DOCS tag, but the result is not
what I want.

Any suggestion?

Thanks,
            Angela.

[Doxygen-users] namespace list

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

I've recognized the following:

If I wrote the documentation within the header file a link to the class /
function documentation is created by doxygen, but if the documentation is
written within the source files (*.cpp) no link is created...

How can I force doxygen to create links for those classes / functions ?

Thanks
Best Regards

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

[Doxygen-users] problem with inheritance and namespaces

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

Hi all!

I have the following problem, and I think is a bug:

--------------------------------------------------

namespace ns { // #####

  /**
   * the parent template class =

   */
  template <class T>
    class A {
  };
  =

  /**
   * alias for A<int>
   */
  typedef A<int> iA;
  =

  /**
   * inherited class
   */
  class B : public iA {
  };
  =

} // #####

---------------------------------------------------

If I generate the documentation for this code, the template class B will
not be "connected" with the class A =


If the lines marked with "// #####" are removed, then everything is fine
and the inheritance tree is build correctly:  class B inherits from A.

Does anyone knows a workaround for this, or can this be fixed?

I used the last version in the CVS-repository (the configuration file
has a  1.2.7-20010524  label)

Regards

Pablo

-- =

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

RE: [Doxygen-users] Configuration options related to the preprocessor

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

Well while I encircled this error I found out that it is my case somehow
(see file testdefine)...

But anyhow it would be nice if the parser would not hang up due to this
error.
Best Regards / Mit freundlichen Gr=FC=DFen

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

-----Original Message-----
From: dox...@li...
[mailto:dox...@li...]On Behalf Of Dimitri
van Heesch
Sent: Dienstag, 29. Mai 2001 21:12
To: dox...@li...
Subject: Re: [Doxygen-users] Configuration options related to the
preprocessor


On Tue, May 29, 2001 at 10:19:40AM +0200, Peter Thie=DF wrote:
> If I set "ENABLE_PREPROCESSING =3D YES" doxygen hangs just before "Free=
ing
> input..."
> If I set "ENABLE_PREPROCESSING =3D NO" (see below) everything works fin=
e,
> except the fact that none of the defined macros were expanded.
>
>
#------------------------------------------------------------------------=
---
> # Configuration options related to the preprocessor
>
#------------------------------------------------------------------------=
---
> ENABLE_PREPROCESSING   =3D NO
> MACRO_EXPANSION        =3D YES
> EXPAND_ONLY_PREDEF     =3D NO
> SEARCH_INCLUDES        =3D YES
> INCLUDE_PATH           =3D
> INCLUDE_FILE_PATTERNS  =3D
> PREDEFINED =3D
> EXPAND_AS_DEFINED      =3D
>
> Is there a limitation within preprocessor directives or preprocessor
> operators?
> Any ideas?

This is clearly a bug in the preprocessor. It would really help me if
you could construct a (small) example that allows me to reproduce the
lock up.

Regards,
  Dimitri

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

Re: [Doxygen-users] Configuration options related to the preprocessor

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

On Tue, May 29, 2001 at 10:19:40AM +0200, Peter Thieß wrote:
> If I set "ENABLE_PREPROCESSING = YES" doxygen hangs just before "Freeing
> input..."
> If I set "ENABLE_PREPROCESSING = NO" (see below) everything works fine,
> except the fact that none of the defined macros were expanded.
> 
> #---------------------------------------------------------------------------
> # Configuration options related to the preprocessor
> #---------------------------------------------------------------------------
> ENABLE_PREPROCESSING   = NO
> MACRO_EXPANSION        = YES
> EXPAND_ONLY_PREDEF     = NO
> SEARCH_INCLUDES        = YES
> INCLUDE_PATH           =
> INCLUDE_FILE_PATTERNS  =
> PREDEFINED =
> EXPAND_AS_DEFINED      =
> 
> Is there a limitation within preprocessor directives or preprocessor
> operators?
> Any ideas?

This is clearly a bug in the preprocessor. It would really help me if
you could construct a (small) example that allows me to reproduce the
lock up.

Regards,
  Dimitri

RE: [Doxygen-users] Doxygen-1.2.7-20010524 in CVS

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

Hello.

I finally managed to finish my revision of the Doxygen documentation.
I fixed some small typos, tried to keep consistency in case (HTML vs. Html,
doxygen vs. Doxygen, etc.), etc.

I didn't made big changes of the content itself.

Beware: these changes are made by somebody whose English language isn't his
native language (it shows in this very message!).
Even worse, my knowledge of English language is mostly intuitive (this
doesn't *look* right), as I forgot most of the rules...
So, I could have missed some errors, and even worse, I could have added
some... Be careful when merging my changes!
PS: I didn't even compiled the changed files, so I could have broken
something.

But I hope I contributed a little to this wonderful tool.

Thank you Dimitri for your hard work and dedication.

Regards.

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

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

[Doxygen-users] \newtheorem

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

Hi all,

I have to write a little chapter of only documentation for a big project
and I'm using Doxygen. I mean I'm writing all the documentation between
/*! and */.
I'd like to use the latex special command \newtheorem: do you know if
there is a way to do this? I need to give many definitions and theorems
and this will be very useful.

Thanks,
  Angela.

[Doxygen-users] [JAVA] add package

[<sc...@ut...>]

Hi

I'm missing the package of the Java Files in generated doku for a java 
class.

It would be nice to have the package on top of the page like the 
#include in the doku of C++ classes.

C++:
#include <tkcuattr.h> 

java:
pacakge my.java.package

where my.java.package is a link to the package description

comments welcome
Peter

[Doxygen-users] Configuration options related to the preprocessor

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

If I set "ENABLE_PREPROCESSING =3D YES" doxygen hangs just before "Freein=
g
input..."
If I set "ENABLE_PREPROCESSING =3D NO" (see below) everything works fine,
except the fact that none of the defined macros were expanded.

#------------------------------------------------------------------------=
---
# Configuration options related to the preprocessor
#------------------------------------------------------------------------=
---
ENABLE_PREPROCESSING   =3D NO
MACRO_EXPANSION        =3D YES
EXPAND_ONLY_PREDEF     =3D NO
SEARCH_INCLUDES        =3D YES
INCLUDE_PATH           =3D
INCLUDE_FILE_PATTERNS  =3D
PREDEFINED =3D
EXPAND_AS_DEFINED      =3D

Is there a limitation within preprocessor directives or preprocessor
operators?
Any ideas?

Thanks in Advance

Best Regards / Mit freundlichen Gr=FC=DFen

Peter Thie=DF
mailto:ph...@ra...

[Doxygen-users] Associate time w/ todo list

[Rod O. <oll...@SE...>]

Is there any method available to assoctiate an estimated time to
completion with an @todo entry?

Cheers,
Rod