doxygen-users — List for users of doxygen

Re: [Doxygen-users] Cannot download from the website

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

Jeff Garland wrote:
> 
> For the last 24 hours I have been trying to download a binary update from the
> download page, but the ftp server appears to be down.  Anyone else having
> trouble?

Same problem: ftp.stack.nl refuses my connection attempts.
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] Cannot download from the website

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

For the last 24 hours I have been trying to download a binary update from the
download page, but the ftp server appears to be down.  Anyone else having
trouble?

Jeff

[Doxygen-users] doxytag & qt 3.0

[Xander B. <xb...@fo...>]

Hi,

Doxytag used to be able to generate a tags file of the qt documentation. 
However, if I run doxytag -t qt.tag $QTDIR/doc/html/*.html a nearly empty 
tags file is produced. All html files are parsed, but the tagfile looks like 
this:

<tagfile>
</tagfile>

Ideas, anyone?

Xander Burgerhout
Fokker Space BV Leiden
The Netherlands

RE: [Doxygen-users] General question on using doxygen with Java

[Paul S. <Pa...@sc...>]

Very good.  There is a flag in the configuration file that tells doxygen to
pay attention to JavaDoc flags

> -----Original Message-----
> From: Ken McDonald [mailto:ke...@be...]
> Sent: Thursday, August 30, 2001 10:46 AM
> To: dox...@li...
> Subject: [Doxygen-users] General question on using doxygen with Java
> 
> 
> I see in some of the recent release notes that doxygen now
> supports Java, but I can't find any information in the documentation
> as to what this support consists of, how thorough it is, etc etc.
> If possible, I'd like to use doxygen to document my own Java
> code, as I think that (judging from the C++/C output), doxygen
> is vastly superior to JavaDoc. Before I start putting in a lot of
> time trying to get it all working, though, could someone comment
> as to the general level of support for Java (i.e. basic, 
> good, advanced?),
> and outline any potential "gotcha's"?
> 
> Thanks,
> Ken McDonald
> ke...@be...
> 
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxygen-users
> 

[Doxygen-users] Link error on 'atend' in make 1.2.10

[Michael D. <de...@cl...>]

Greetings! I'm trying to make doxygen from the 1.2.10 source tarball on a 
Mandrake 7.1 machine. I get an error and I'm not sure what to try to do to 
fix it. Can anyone advise?

-Mike

gmake[2]: Entering directory `/export/share/doxygen/doxygen-1.2.10/src'
g++  -o ../bin/doxygen ../objects/main.o  -L../lib -ldoxygen -ldoxycfg 
-lqtools
../lib/libdoxygen.a(doxygen.o): In function `findFunctionPtr(QCString const 
&, int *)':
doxygen.o(.text+0x64d3): undefined reference to `atexit'
../lib/libdoxygen.a(doxygen.o): In function `buildVarList(Entry *)':
doxygen.o(.text+0x67fa): undefined reference to `atexit'
../lib/libdoxygen.a(doxygen.o): In function 
`getTemplateArgumentsInName(ArgumentList *, QCString const &)':
doxygen.o(.text+0xa518): undefined reference to `atexit'
../lib/libdoxygen.a(memberdef.o): In function 
`MemberDef::getClassDefOfAnonymousType(void)':
memberdef.o(.text+0x2c15): undefined reference to `atexit'
../lib/libdoxygen.a(memberdef.o): In function 
`MemberDef::writeDeclaration(OutputList &, ClassDef *, NamespaceDef *, 
FileDef *, GroupDef *, bool)':
memberdef.o(.text+0x3ee0): undefined reference to `atexit'
../lib/libdoxygen.a(memberdef.o)(.text+0x53d8): more undefined references 
to `atexit' follow

Michael Deck
Cleanroom Software Engineering, Inc.   

[Doxygen-users] General question on using doxygen with Java

[Ken M. <ke...@be...>]

I see in some of the recent release notes that doxygen now
supports Java, but I can't find any information in the documentation
as to what this support consists of, how thorough it is, etc etc.
If possible, I'd like to use doxygen to document my own Java
code, as I think that (judging from the C++/C output), doxygen
is vastly superior to JavaDoc. Before I start putting in a lot of
time trying to get it all working, though, could someone comment
as to the general level of support for Java (i.e. basic, good, advanced?),
and outline any potential "gotcha's"?

Thanks,
Ken McDonald
ke...@be...

[Doxygen-users] Search fails on doxygen-users

[Michael D. <de...@cl...>]

When I try to search on doxygen-users, I get

htsearch detected an error. Please report this to the returned matches

webmaster of this site. The error message is:
Unable to read configuration file '/bigassraid/htdig//conf/11668.conf'

I'm not finding a link for a webmaster and when I click on "About" it says 
Geocrawler is no longer being maintained.

Michael Deck
Cleanroom Software Engineering, Inc.   

[Doxygen-users] Question on documenting similar (overloaded functions)

[<adn...@on...>]

I am trying to document some code and the problem I am having is to group some
functions together. For example I am overloading the
'=' operator and passing a char*,char and some other different types. Each of
these has there own function. For e.g.

const DATATYPE operator =(const char *str) ;
const DATATYPE operator =(const char ch) ;
const DATATYPE operator =(int number) ;

Now instead of having three different comment blocks, one for each, I was hoping
to group these together so that they come up in the documentation as

const DATATYPE operator=

const DATATYPE operator =(const char *str) ;
const DATATYPE operator =(const char ch) ;
const DATATYPE operator =(int number) ;

Parameters:

char* str , character pointer.
char ch, character
int number, integer

Remarks:
     This is the overloaded operator.


     This way, there are not four different functions to click on in the html
documentation. I am trying to do this to make it similar to MSDN documentation
and easier to
read.

Thank you for all your help.
Adnan.

[Doxygen-users] class hierarchies with templates and doxygen 1.2.10

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

Hi,

this is just to report experiences with templated class hierarchies with the
latest doxygen. Sorry to keep banging on about this, but my class
hierarchies are becoming ever more complicated and doxygen doesn't seem to
keep up :-)

First of all, when HAVE_DOT=YES, the inheritance diagrams seem to be much
better now. Great ! The class hierarchies page is still incomplete. This
might be by design though (see one of my previous emails on the difficulty
in starting from base-level with templated hiearchies). Unfortunately, it
looks like the non-dot inheritance diagrams reflect the situation of the
'class hierarchies page', instead of the dot-generated hierarchies. I don't
see any particular reason for this, but as I have dot now, I'll live with it
(I would put it in the doxygen doc somewhere though Dimitri).

First, an illustration of 'incompleteness' of the class hierarchy:

//! Base
class Base {};
//! B
template <class A> class B {};
//! B2
class B2 : public B<Base> {};

The class hierarchy (and non-dot inheritance graph) does not show that B2 is
derived from B.



Unfortunately, even the dot-generated inheritance diagrams can have
problems. I spotted the following 2 remaining problems:

problem 1:
----------
doxygen can get confused when the name of the template parameter is the same
as the name of a class.
Example:
//! Base
class Base {};

//! E
template <class BASE> class E: public BASE{};
//! F
class F : public E<Base> {};

//! EE
template <class Base> class EE: public Base{};
//! FF
class FF : public EE<Base> {};

As far as C++ goes, E,F and EE,FF are exactly the same. Doxygen's output
differs in 3 ways though:
- in the class hierarchies page, FF is show as derived from EE<Base> (but
not from Base), while F is not shown to be derived from E<Base>.
- in F's inheritance diagram, there is an orange arrow splitting off from
E<Base> to E<BASE>. This isn't there in FF's diagram
- in Base's inheritance diagram, E<Base>,F appear, but EE<Base>,FF not.


problem 2:
----------
a problem with default template parameters

Example:
//! Base
class Base {};
//! E
template <class BASE> class E: public BASE{};
//! Base2
class Base2{};

//! WithDefault
template <class X,class A=E<X> > class WithDefault : public A {};
//!UseDefault
class UseDefault:public WithDefault<Base2> {};
//!NoDefault
class NoDefault:public WithDefault<Base2,E<Base> > {};

As far as C++ goes, UseDefault and NoDefault are again the same. However,
doyxgen infers only for NoDefault the correct hierarchy. For UseDefault, the
dot graph shows it's derived from E<X> (which is derived from X). That is,
it failed to fill in the X template parameter.


Hopefully these 2 are not too difficult to fix... Many thanks Dimitri for
all your work!


Kris

RE: [Doxygen-users] template functions again

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

>
> When I generate the documentation (version 1.2.9.1), my class will be
> documented was it should be. But I'm not able to discover the
> documentation
> for my global template function.
> Am I doing anything wrong?

With 1.2.9.1 and 1.2.8.1 they would end up in the section 'namespace
members' if they're in a namespace, or 'file members' if they're not.

I used

//! Threshold a sequence from above and below
/*! bla
*/
template <typename forw_iterT, typename elemT>
inline void
threshold_upper_lower(forw_iterT begin, forw_iterT end,
		      const elemT new_min, const elemT new_max)
{ 
 // code
}

[Doxygen-users] Macros

[Stefan M. <me...@sk...>]

Forwarded from developlist

Stefan Maton
-----------------------------
Programmer Resources Site
http://www.sun-a-moon.org
-----------------------------

> -----Message d'origine-----
> De : dox...@li...
> [mailto:dox...@li...]De la part de Stefa=
n
> Maton
> Envoy=E9 : Montag, 27. August 2001 10:47
> =C0 : Doxygen mailing list
> Objet : [Doxygen-develop] Macros
>
>
> Hi,
>
> I have following class definition :
>
>
> // ----------------------------------------------------------
> // Class definition.
> class CRandomGenerator : public IRandomGenerator
> {
>
> public:
> [...snipped code...]
>
> 	// ------------------------
> 	// Seed setting.
>
> 	IWMETHODIMP(void)SetSeed( ulong _uSeed );
> 	IWMETHODIMP(ulong)GetSeed();
>
> [...snipped code...]
> };
>
> IWMETHODIMP is defined within another header that is not
> included in the randomgenerator header in this way :
>
> #define IWMETHODCALLTYPE __stdcall
> #define IWMETHODIMP(type)		type IWMETHODCALLTYPE
>
> Unfortunately, doxygen doesn't seem to be able to resolve following
> comment :
>
> /*! \fn IWMETHODIMP(void) CRandomGenerator::SetSeed( ulong _uSeed );
>  *  \brief Set the seed of the random number generator.
>  *  \param _uSeed The seed to use.
>  */
>
> I also tried to put the comment just above the SetSeed function
> declaration
> in this way :
>
> /*! \fn IWMETHODIMP(void) SetSeed( ulong _uSeed );
>  *  \brief Set the seed of the random number generator.
>  *  \param _uSeed The seed to use.
>  */
>
> Which didn't work, too...
>
> The warning I get is :
> D:/Projekte/IW/Src/baselib/Random/Random.h:38 Warning: member SetSeed o=
f
> class C
> RandomGenerator cannot be found
>
> What can I do ?
>
> Kind regards,
> Stefan Maton
> -----------------------------
> Programmer Resources Site
> http://www.sun-a-moon.org
> -----------------------------
>
>
> _______________________________________________
> Doxygen-develop mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxygen-develop
>

[Doxygen-users] Macros II

[Stefan M. <me...@sk...>]

Forwarded from developlist

Stefan Maton
-----------------------------
Programmer Resources Site
http://www.sun-a-moon.org
-----------------------------

> -----Message d'origine-----
> De : dox...@li...
> [mailto:dox...@li...]De la part de Stefa=
n
> Maton
> Envoy=E9 : Montag, 27. August 2001 13:50
> =C0 : Doxygen mailing list
> Objet : [Doxygen-develop] Macros II
>
>
> Hi,
>
> I've advanced somewhat in my quest to make the stuff work.
>
> I set the macro expansion
>
> PREDEFINED             =3D "IWMETHODIMP(x)=3Dx __stdcall " \
>                          "PURE=3D =3D 0"
>
> and
>
> EXPAND_AS_DEFINED      =3D "IWMETHODIMP(x)=3Dx __stdcall " \
>                          "PURE=3D =3D 0"
>
> and enabled all macro expansion like this :
>
> ENABLE_PREPROCESSING   =3D YES
> MACRO_EXPANSION        =3D YES
> EXPAND_ONLY_PREDEF     =3D YES
>
> I now get this error message :
>
> D:/Projekte/IW/Src/baselib/Random/Random.h:48 Warning: no matching clas=
s
> member
> found for
>   IWMETHODIMP IW::CRandomGenerator::SetSeed(void)
>
> since SetSeed is defined as :
>
> 	IWMETHODIMP(void) SetSeed( ulong _uSeed );
>
> I suppose that the macro is either
>
> - not expanded as should
>
> or
>
> - I made a fault within the PREDEFINED declaration.
>
> If anyone had a suggestion what I could do, I appreciate.
>
> Kind regards,
> Stefan Maton
> -----------------------------
> Programmer Resources Site
> http://www.sun-a-moon.org
> -----------------------------
>
>
> _______________________________________________
> Doxygen-develop mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxygen-develop
>

[Doxygen-users] conditional documentation

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

Hello Dimitri and anyone who can help!

I'm just evaluating version 1.2.10 of doxygen and still have problems with =
conditional documentation.

Using the conditional construct=20

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

with the follwing entry in the configuration file =20

ENABLED_SECTIONS       =3D MY_LABEL1
GENERATE_TODOLIST      =3D YES

still does nothing (no group is generated).

Forcing the generation of Group1, not using an conditional construct
the following documention

/** @class middle

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

will give
---------------------------------------------------------------------------=

Detailed Description
template<class T>
class middle< T >
@ingroup@addtogroup=20
Definition at line 135 of file ctest.cpp.
---------------------------------------------------------------------------=
----

And the description is not added to the group Group1!

Is there something wrong in using the possibilities of conditional =
documentation?

Thanks
Klaus

[Doxygen-users] template functions again

[Stephan S. <ste...@we...>]

Hi again!

I am quite unsure whether my original mail got through. So I try it again,
describing my problem more detailed:

I've created a template class for vector/ matrix computation. Here's a
sniplet from vector.h:
-------------------------------------
/**
 * @class Vector
 */
template<int N, typename T>class Vector {
  public:
  /**
   * Standard constructor
   */
  Vector() {}
-------------------------------------


For this template, I created some global, template functions, i.e. they are
not members of the class itself. E.g. (again vector.h):
-------------------------------------
/**
 * cross product for dimension 3 vectors
 */
template <typename T>
Vector<3,T> cross(const Vector<3,T>& lhs, const Vector<3,T>& rhs) {
  T tmp[3];
  tmp[0] = lhs[1] * rhs[2] - lhs[2] * rhs[1];
  tmp[1] = lhs[2] * rhs[0] - lhs[0] * rhs[2];
  tmp[2] = lhs[0] * rhs[1] - lhs[1] * rhs[0];
  return Vector<3,T>(tmp);
} /* !dot() */
-------------------------------------

When I generate the documentation (version 1.2.9.1), my class will be
documented was it should be. But I'm not able to discover the documentation
for my global template function.
Am I doing anything wrong?

btw: When I try to document my type definitions within the same header file
using

/**
 * @var   typedef Vector<4,int> Vector4i      specialization of the base
template .....
 */

I don't get any results in the documentation either.

Thanks in advance,

Stephan

[Doxygen-users] Doxygen-1.2.10 in CVS

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

Hi,

Here is what has changed since the last update:
---------------------------------------------------------------------------
+ ADD: Included translator.pl update received from Petr.
+ BUG: Fixed & changed the layout of function arguments a little.
+ BUG: Typedef struct{}Name was not parsed properly without adding more spaces.
+ BUG: Static initializer blocks were not properly parsed in Java classes.
+ BUG: Members of an unnamed namespace are now treated as static, and will
       only appear in the documentation if EXTRACT_STATIC is set to YES.
+ BUG: Classes are sorted by their name, i.s.o. full scope again.
+ BUG: Improved argument matching for members defined within (nested)
       namespaces.
---------------------------------------------------------------------------
Enjoy,
  Dimitri

[Doxygen-users] why are only some of my classes documented when I set EXTRACT_ALL to no

[Richard H. <Ric...@Wa...>]

Hi:
=20
I have a sample file for a dll I am trying to document. I thought that
it would be good to maintain the actual class descriptions in the =
sample
file rather then in the headers or in the implementation files. It =
works
for the CeField and CeItem class only. Does any-one have any idea why?
=20
thanks
=20
Rich
=20
=20
  /*! \fn errReport
  \brief log something
 =20
    C style binding to the error api this is just used as is (no new
abstraction)
  */
=20
  CString sMess("Hello from our friend");
  errReport( SEVERITY_INFO,
ROLE_ERROR_INFO,sMess.Left(ERRAPI_MAX_ERROR_LENGTH));
 =20
  /*! \class  CeField
  \brief a field entity
 =20
    A CeField is the type of the basic element in the framework. It is =
a
variant based on an integer, string, date or blob. It has operators to
coerce it into the other types. It is used by items and by the monitor
to hold elements of information.
  */
  CeField fTest =3D 1;
 =20
  int i =3D fTest;
  CString sTest =3D fTest;

  /*! \class  CeItem
  \brief a record entity
 =20
    A CeItem is a collection of fields. It can be any database record,
returned as the result of a database query. An item has update and
insert methods as well, which may be of use in the framework. It has an
[] operator to dereference the fields.
  */
 =20
  CeItem iTest;
  iTest["test"] =3D 1;
  iTest["tool"] =3D 2;
  iTest.dumpMap(0);
  iTest["test"] =3D CString("3");
  iTest.dumpMap(0);
 =20
  int j =3D iTest["test"];
  CeItem *pTest =3D &iTest;
  int k =3D (*pTest)["tool"];
 =20
  cout << (LPCSTR)iTest["test"] << endl;
 =20
  /*! \class  CMonitor
  \brief the context=20
 =20
    The monitor provides much of the context for an application. The
context is stored in fields which can be dereferenced by an [] =
operator.
The monitor is a singleton. This means that it can only be instantiated
once and that it has a static method which returns an instance of
itself. The method is invoked as such: Cmonitor::instance();
  */
  CMonitor theMon(NULL, NULL);
  theMon.getString("test");
 =20
  /*! \class  CExtDatabase
  \brief interface to ODBC data source
 =20
    The main extension to a CDatabase is nest-able database
transactions. There is also support for precompiled sql which is used =
by
the CeItemList.
  */
 =20
 =20
  CExtDatabase m_dbRef;
  m_dbRef.OpenEx("DSN=3Dmodeltest.localhost");
 =20
  /*! \class  CODBCItemList
  \brief list of database items
  A collection of CeIItems. An ODBCItemList also has a CExtDatabase. =
The
main points of interest are some iteration macros as well as the query
and do methods which take sql with bind-variables and a list of fields
to use in the execution of the sql.
  */
 =20
 =20
  CODBCItemList lTest(&m_dbRef, &m_dbRef);
  lTest.query("select * from uowattribute where interaction =3D ?", -1,
-1, &CeField(743));
  FOR_EACH(lTest, CeItem*, pItem)
  {
   cout << (LPCSTR)(*pItem)["uowid"] << endl;
  }
  END_FOR;
  m_dbRef.Do("insert into tab(tname) values(?)", &CeField("test"));
  lTest.emptyAll();
  lTest.query("select tname from tab");
  FOR_EACH(lTest, CeItem*, pItem)
  {
   cout << (LPCSTR)(*pItem)["tname"] << endl;
  }
  END_FOR;
 =20
  m_dbRef.Do("delete from tab where tname =3D ?", &CeField("test"));
 =20
  const char* szInitServerName    =3D (const
char*)theMon.getService("IESS_SERVICE").ServiceStnName;
  const char* szInitServiceName   =3D (const
char*)theMon.getService("IESS_SERVICE").ServiceName;
  const char* szInitAppClassName  =3D (const =
char*)theMon["AppClassName"];

  const char* szInitAppTypeName   =3D (const =
char*)theMon["AppTypeName"];
 =20
  /*! \class CValidatorSS
 =20
    An abstraction of the sort simulator. Parses and finds distribution
of codelines and items.
  */
 =20
  CValidatorSS *m_pSortSimulator =3D new CValidatorSS(szInitServerName,
   szInitServiceName,
   szInitAppClassName,
   szInitAppTypeName);
=20
  m_pSortSimulator->OnNewParameterSet(1);
  iTest["field1"] =3D "1000";
  iTest["field2"] =3D "01";
  iTest["field3"] =3D "100000090";
  iTest["field4"] =3D "222222226";
  int FieldInError;
  short int Distribution, Classification;
  m_pSortSimulator->Validate(&iTest, FieldInError, Distribution,
Classification);
 =20
  delete m_pSortSimulator;
=20
=20

[Doxygen-users] template function problems

[Stephan S. <ste...@we...>]

Hello out there!

Recently I tried documenting a template class for the first time using
doxygen, which works rather fine.
I also provide a few template classes which I try to document using the
standard "function header"

/**
 * In this function, I do _something_
 */
function declaration


But unfortunately, this template function doesn't appear in the
doxygen-erated documentation. What am I doing wrong? Could maybe someone
give me a short real-life example for a correct template class/ function
documentation?!

Thanks in advance,

Stephan

Re: [Doxygen-users] Missing </para> (again)

[Christian H. <ch...@po...>]

On Fri, Aug 24, 2001 at 11:55:03AM -0700, Christian Hammond wrote:
> On Fri, Aug 24, 2001 at 08:01:47PM +0200, Dimitri van Heesch wrote:
> > Please send an example that produces this output. Otherwise your bug report
> > is of little use.
> 
> I've determined that this problem only occurres when JAVADOC_AUTOBRIEF
> is set to YES. Here's some sourcecode that will fail:
> 

[snip]

I managed to fix that problem, and attached the patch. It appears to
work on my sourcecode. It also fixes a couple other minor problems,
such as other missing </para> tags and <highlight> tags missing a >.

There are some other problems I'm noticing with unbalanced
<linenumber> tags. I'm working on that now.

Christian

-- 
Christian Hammond         <>  Portal Web Design
ch...@po...  <>  http://www.portaldesign.net
   Why does the person that snores always fall asleep first?

Re: [Doxygen-users] Missing </para> (again)

[Christian H. <ch...@po...>]

On Fri, Aug 24, 2001 at 08:01:47PM +0200, Dimitri van Heesch wrote:
> On Thu, Aug 23, 2001 at 12:10:58PM -0700, Christian Hammond wrote:
> > I'm using the latest doxygen CVS as of 5 minutes ago. It is
> > generating a resulting XML file without end </para> tags inside the
> > <title>..</title> of a <parameterlist>. The resulting XML comes out
> > like this:
> > 
> > <parameterlist kind="param"><title><para>
> > Parameters: </title> [snip]
> 
> Please send an example that produces this output. Otherwise your bug report
> is of little use.

I've determined that this problem only occurres when JAVADOC_AUTOBRIEF
is set to YES. Here's some sourcecode that will fail:


/**
 * @file bugtest.h Bug Test
 */
#ifndef _BUGTEST_H_
#define _BUGTEST_H_

/**
 * This will cause an error in the XML output when JAVADOC_AUTOBRIEF
 * is set to YES.
 *
 * @param param1  Parameter 1.
 * @param param2  Parameter 2.
 *
 * @return 1.
 */
int bugtest(int param1, int param2);

#endif /* _BUGTEST_H_ */


> > Are there any plans for adding an option to the XML generator for
> > generating multiple files similar to the HTML generator instead of a
> > single doxygen.xml file? Also, what about doxygen tag file support and
> > dot graphs?
> 
> All will come in due time. Hint: if you help and add one of these 
> yourself developments will go faster.

I'll study the code a bit and see what I can do.

Christian

-- 
Christian Hammond         <>  Portal Web Design
ch...@po...  <>  http://www.portaldesign.net
   There are two major products that come out of Berkeley: LSD and BSD [Unix].
   We don't believe this to be a coincidence.
      -- Jeremy S. Anderson

Re: [Doxygen-users] Missing </para> (again)

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

On Thu, Aug 23, 2001 at 12:10:58PM -0700, Christian Hammond wrote:
> I'm using the latest doxygen CVS as of 5 minutes ago. It is
> generating a resulting XML file without end </para> tags inside the
> <title>..</title> of a <parameterlist>. The resulting XML comes out
> like this:
> 
> <parameterlist kind="param"><title><para>
> Parameters: </title> [snip]

Please send an example that produces this output. Otherwise your bug report
is of little use.

> 
> Are there any plans for adding an option to the XML generator for
> generating multiple files similar to the HTML generator instead of a
> single doxygen.xml file? Also, what about doxygen tag file support and
> dot graphs?

All will come in due time. Hint: if you help and add one of these 
yourself developments will go faster.

Regards,
  Dimitri

[Doxygen-users] Missing </para> (again)

[Christian H. <ch...@po...>]

I'm using the latest doxygen CVS as of 5 minutes ago. It is
generating a resulting XML file without end </para> tags inside the
<title>..</title> of a <parameterlist>. The resulting XML comes out
like this:

<parameterlist kind="param"><title><para>
Parameters: </title> [snip]

Are there any plans for adding an option to the XML generator for
generating multiple files similar to the HTML generator instead of a
single doxygen.xml file? Also, what about doxygen tag file support and
dot graphs?

Christian

-- 
Christian Hammond         <>  Portal Web Design
ch...@po...  <>  http://www.portaldesign.net
   "Technological progress is like an axe in the hands of a pathological
   criminal." -- Albert Einstein

[Doxygen-users] order of modules in RTF/LaTex and how to exclude some sections?

[John C. <j.c...@ar...>]

We have groups (@defgroup) defined that form a hierarchy
of modules in the generated document.  When generating
RTF or PDF (via LaTex) these groups seem to be ordered
more by when they were encountered in the code rather than
following the group hierarchy -- so I lower level
group/module might have its detailed description come
BEFORE the higher level group.

In HTML this isn't a problem since groups are always
viewed by 'drilling' down.

ALSO, is there a way to exclude top level documentation
sections like 'Files' or 'Data Structures'.  What is
odd about the 'Data Structures' section to me is that it
lists data structures that are also part of some group.
If in a group, we prefer not to see a data structure
(or other declarations) documented until the rest of that
group/module is documented.

Thanks for any ideas!

--John

RE: [Doxygen-users] Latex problems

[Markus L. <lo...@ce...>]

Actually using the latest version was the first thing I tried - I just got
stuck with some compile errors (using QNX6.1).
I get errors like: /usr/include/string.h:155 memcmp is already defined in
that scope"
Somebody uses QNX6 out there?
Markus


> -----Original Message-----
> From: dox...@li...
> [mailto:dox...@li...]On Behalf Of Dimitri
> van Heesch
> Sent: Wednesday, August 22, 2001 2:42 PM
> To: dox...@li...
> Subject: Re: [Doxygen-users] Latex problems
>
>
> On Wed, Aug 22, 2001 at 02:30:25PM -0400, Markus Loffler wrote:
> > Petr,
> > thanks for your very detailed answer. I'm not using any custom tex code.
> > I actually tried some other C++ files, and they work fine.
> > I will try to send Dimitri my example that doesn't work
>
> That's fine. But since you said you were using doxygen version 1.2.3,
> don't forget to try with the latest version of doxygen first
> (CVS if possible). Maybe it is something that has been fixed already.
>
> Regards,
>   Dimitri
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] Latex problems

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

On Wed, Aug 22, 2001 at 02:30:25PM -0400, Markus Loffler wrote:
> Petr,
> thanks for your very detailed answer. I'm not using any custom tex code.
> I actually tried some other C++ files, and they work fine.
> I will try to send Dimitri my example that doesn't work

That's fine. But since you said you were using doxygen version 1.2.3, 
don't forget to try with the latest version of doxygen first 
(CVS if possible). Maybe it is something that has been fixed already.

Regards,
  Dimitri

RE: [Doxygen-users] Latex problems

[Markus L. <lo...@ce...>]

Petr,
thanks for your very detailed answer. I'm not using any custom tex code.
I actually tried some other C++ files, and they work fine.
I will try to send Dimitri my example that doesn't work
Markus


> -----Original Message-----
> From: dox...@li...
> [mailto:dox...@li...]On Behalf Of
> Prikryl,Petr
> Sent: Wednesday, August 22, 2001 1:38 AM
> To: dox...@li...
> Subject: RE: [Doxygen-users] Latex problems
>
>
> You should focus on
> --------------------------
> Runaway argument?
> height=\end {center} \end {figure} \subsubsection *{Public Methods} \begin
> \ETC
> .
> ! Paragraph ended before \Gin@ii was complete.
> <to be read again>
>                    \par
> l.31
> --------------------------
>
> If you did not write any LaTeX code into your sources, then it is probably
> doygen's bug.  In such case, try to create as small as possible example
> and send it to Dimitri.
>
> If you did write some LaTeX code, it may be your problem.
>
> Earlier in the text you should see the name of the file where it happened.
> The problem was discovered on the line 31 (l.31).  The messages
> from screen
> are also captured in the .log file.
>
> The warnings like:
> "LaTeX Warning: Reference `class_ObjectManager' on page 1
> undefined on input
> line 3."
>
> are normal and you should ignore them in the first run. LaTeX collects
> the labels and the related information to your .aux file and warns
> if the reference is placed earlier than the label.  Bold question marks
> are used instead of real values in the document (page, chapter, section
> numbers).
> When you run the LaTeX for the second time, the warnings will disappear
> because the values for the labels are found in the .aux file.  It
> can happen
> that the text moves, so the numbers for the labels change.  In such
> case, you can observe:
>
> "LaTeX Warning: Label(s) may have changed. Rerun to get cross-references
> right."
>
> Then you are expected to run LaTeX again.  I have observed that
> the process
> always converges.  If index and table of contents is generated,
> it can take
> more that 2 (usually 3 or 4 runs).
>
> Also, if you were prepare the document manually, the .aux file is
> gradually
> updated with each run that you need for generating preview.  In such case,
> you only sometimes need more than one run.  This fact and the speed
> of earlier computers was probably the reason not to do the subsequent run
> automatically.  And also, there still is some chance that the label really
> does not exist.
>
> Regards,
>   Petr
>
> --
> Petr Prikryl, SKIL, spol. s r.o., pri...@sk...
>
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxygen-users
>