doxygen-users — List for users of doxygen

Re: [Doxygen-users] Doxygen install

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

I've had to use the -g option and specify a group in the make file to have a
successful install.
try looking at the man page for install.

Hope this helps.
-Jonathan

shahmil merchant wrote:
> 
> Hi,
> I am tryiing to install Doxygen on a Sun machine 8 with a gcc=2.95
> compiler.I have manged to do a configure and a make on the software.But the
> moment i try to do a make install i get the following:
> install -d /opt/software/bin
> install -d /opt/software/share/doc/packages/doxygen
> install -m 755 bin/doxygen    /opt/software/bin
> install -m 755 bin/doxytag    /opt/software/bin
> install -m 755 bin/doxysearch /opt/software/bin
> cp -r doc /opt/software/share/doc/packages/doxygen
> cp -r examples /opt/software/share/doc/packages/doxygen
> echo "DOXYGEN  = /opt/software" >
> /opt/software/share/doc/packages/doxygen/doc/
> Makefile
> echo "DOXYDOCS = .."         >>
> /opt/software/share/doc/packages/doxygen/doc/Mak
> efile
> echo "VERSION  = 1.2.7" >>
> /opt/software/share/doc/packages/doxygen/doc/Makefile
> cat doc/Makefile.in          >>
> /opt/software/share/doc/packages/doxygen/doc/Mak
> efile
> cd /opt/software/share/doc/packages/doxygen/examples ; /usr/local/bin/make
> make[1]: Entering directory
> `/opt/software/share/doc/packages/doxygen/examples'
> /home/smerchant/doxygen/doxygen-1.2.7/bin/doxygen class.cfg
> ld.so.1: /home/smerchant/doxygen/doxygen-1.2.7/bin/doxygen: fatal:
> libstdc++.so.
> 2.10.0: open failed: No such file or directory
> make[1]: *** [class/html/index.html] Killed
> make[1]: Leaving directory
> `/opt/software/share/doc/packages/doxygen/examples'
> make: *** [install] Error 2
> 
> Can you please tell me what the problem is........I am stuck on this problem
> for quite a while!
> Thanks
> Shahmil
> 
> ----------------------------------------------------------------------------
> Get Your Private, Free E-mail from MSN Hotmail at http://www.hotmail.com.
> 
> _______________________________________________ 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] Typedef Aliases Don't Work

[Scott P. <sco...@ho...>]

The documentation for doxygen clearly states:

"Typedefs that involve classes, structs and unions, like
typedef struct StructName TypeName
create an alias for StructName, so links will be generated to =
StructName,  when either StructName itself or TypeName is encountered."


However this is NOT true.  The example HTML documentation does not even =
do this.  Clicking on the name of the typedef in the example =
documenation in the online help brings you to documentation for the =
typedef itself NOT the associated struct.

This problem seems to have been around since at least 1.2.6, and is =
still present in 1.2.8.

Are there any workarounds?  Is this a known problem?

Thanks,

Scott

Re: [Doxygen-users] class hierarchy

[Victor A. W. Jr. <va...@ru...>]

The actual difference between struct and class is very minimal (yes, 
structs can have constructors, destructors, everything classes can have).

Why do YOU think they're different?

At Thursday 2001/06/07 02:49, you wrote:
>Doxygen's generated class hierarchy (both text and graphical) includes
>structs and unions declared in header files.
>
>Can structs and unions be excluded from appearing in the class hierarchy
>only, but shown else where in the documentation. Only the classes are
>required to be shown in the class hierarchy.
>
>Regards
>Jacky
>
>
>
>IMPORTANT NOTICE:
>This e-mail and any attachment to it is intended only to be read or used by
>the named addressee.  It is confidential and may contain legally privileged
>information.  No confidentiality or privilege is waived or lost by any
>mistaken transmission to you.  If you receive this e-mail in error, please
>immediately delete it from your system and notify the sender.  You must not
>disclose, copy or use any part of this e-mail if you are not the intended
>recipient.  The RTA is not responsible for any unauthorised alterations to
>this e-mail or attachment to it.
>
>_______________________________________________
>Doxygen-users mailing list
>Dox...@li...
>http://lists.sourceforge.net/lists/listinfo/doxygen-users

Victor A. Wagner, Jr.
PGP RSA fingerprint = 4D20 EBF6 0101 B069 3817 8DBF C846 E47A
PGP D-H fingerprint = 98BC 65E3 1A19 43EC 3908 65B9 F755 E6F4 63BB 9D93
The five most dangerous words in the English language:
               "There oughta be a law"

[Doxygen-users] RTF questions

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

Hi Doxygeners!

Maybe you can help me solving following problems:

## 1 ##

Suppose following header file comment:

/**
...
 * <PRE>
 * -------------------    -----------------------    -------
 * | mem buf       1 |    | mem buf 2           |    | mb3 |
 * -------------------    -----------------------    -------
 * </PRE>
...
*/

In HTML output I get correct stuff:

   -------------------    -----------------------    -------
   | mem buf       1 |    | mem buf 2           |    | mb3 |
   -------------------    -----------------------    -------


But in RTF the output is as follows (with grey background):

 -------------------    -----------------------    ------- | mem buf       1
|    | mem buf 2           |    | mb3 | -------------------
-----------------------    ------- 


i.e. the linebreaks are not considered.

Any idea to solve this. (If I use <BR> in header the RTF output is ok, but
the HTML contains empty lines)


## 2 ##

With 'doxygen -ertf RET_extension.txt' I can generate and RTF extension
file,
but how to get doxygen using the content when generating RTF document?


## 3 ##
Is there any way to tell m$-word to automatically update RTF file content
(simulate STRG-A, F9)?


Thanks a lot for any suggestion or tip!

BR,
 Markus Lepper

Re: [Doxygen-users] Function grouping problem

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

On Wed, Jun 06, 2001 at 11:44:10AM -0700, Marc Betz wrote:
> class I define a group of functions without a preceding comment defining
> a group name (the @name command), like so:
> 
> /*! \defgroup Groupname Collection Classes
>  *  This set of classes supports various sorts of collections.
>  */
> 
> class SomeClass {
> ...
> 
> //@{
> someFunc1();
>   //!< Documentation for this group of functions.
> someFunc2();
> someFunc3();
> //@}
> ...
> }
> 
> I find that the function group appears on and is documented on some
> module page (it is hard to predict which one), not on the class
> description page.

Which version of doxygen are you using? Some versions had this kind
of problem, but grouping was partly rewritten since then and the latest
version should work as expected.

Bye, Patrick Ohly
-- 
// 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 
..........................................................

[Doxygen-users] class hierarchy

[NG J. <Jac...@rt...>]

Doxygen's generated class hierarchy (both text and graphical) includes
structs and unions declared in header files. 

Can structs and unions be excluded from appearing in the class hierarchy
only, but shown else where in the documentation. Only the classes are
required to be shown in the class hierarchy.

Regards
Jacky



IMPORTANT NOTICE:
This e-mail and any attachment to it is intended only to be read or used by
the named addressee.  It is confidential and may contain legally privileged
information.  No confidentiality or privilege is waived or lost by any
mistaken transmission to you.  If you receive this e-mail in error, please
immediately delete it from your system and notify the sender.  You must not
disclose, copy or use any part of this e-mail if you are not the intended
recipient.  The RTA is not responsible for any unauthorised alterations to
this e-mail or attachment to it.  

[Doxygen-users] Mimicing the style of Qt documentation

[Jake C. <co...@pp...>]

Trolltech (Qt's developers) are clearly using Doxygen, or a derivate, for its
excellent documentation.  I prefer the 'look' of Qt documentation over the
default 'look' of my doxygen-produced documentation.  Is there a way for me
to use doxygen to generate the Qt 'look'?

Some examples:

1) Qt's member function list for a class does not include the brief
   documentation.  The brief documentation is only shown on the alphabetical
   function list.

2) The fonts used by the Qt docs are nicer than that used by doxygen.

-- 
Jake Colman                     

Principia Partners LLC                  Phone: (201) 946-0300
Harborside Financial Center               Fax: (201) 946-0320
902 Plaza II                           Beeper: (800) 928-4640
Jersey City, NJ 07311                  E-mail: co...@pp...
                                       E-mail: jc...@jn...
                                          web: http://www.ppllc.com

[Doxygen-users] Function grouping problem

[Marc B. <be...@ro...>]

Sorry if this has been discussed before. I did a search on the archive
and could not find anything.

The problem: if I have a project that defines modules, and within a
class I define a group of functions without a preceding comment defining
a group name (the @name command), like so:

/*! \defgroup Groupname Collection Classes
 *  This set of classes supports various sorts of collections.
 */

class SomeClass {
...

//@{
someFunc1();
  //!< Documentation for this group of functions.
someFunc2();
someFunc3();
//@}
...
}

I find that the function group appears on and is documented on some
module page (it is hard to predict which one), not on the class
description page. If you add a group naming comment

/*! @name Accessor Functions */
//@{
someFunc1();
  //!< Documentation for this group of functions.
someFunc2();
someFunc3();
//@}

the function group appears on and is documented on the class description
page as you would like. This means, unless I am doing something wrong,
that I must define a group name if I want to use this feature. I would
rather have the option of not defining a group name if that is possible.
Am I doing anything wrong? If so, what? If not, are there any known
workarounds? (The best one I know is to define an empty group naming
comment

/*! @name */

which forces the correct behavior with only the price of somewhat odd
spacing because of the empty line for the undefined group name.

Cheers,

Marc Betz

[Doxygen-users] html pages (in addition to index.html) in Doxygen output?

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

Hi there,
I've been looking through the documentation and haven't hit on how I
would go about adding html pages to the output. I understand how to use
the \mainpage command in a dummy header  file to put stuff in
index.html:

/*! \mainpage
 *
 * \section Usage
 * <h2> Using blah </h2>
 * <!-- text marked up with html -->
 */

I have a few other pages of html content I'd like to include related to
this run. I could just put it all in the \mainpage with anchors and a
toc at the top, but I was wondering if there was another way to include
the html files without munging them into the header file first.
Including links and dropping them into the directory after generating
the docs doesn't work for me because I need to generate chms.

Thanks,
David

[Doxygen-users] Doxygen install

[shahmil m. <sha...@ho...>]

<html><DIV>Hi,</DIV>
<DIV>I am tryiing to install Doxygen on a Sun machine 8 with a gcc=2.95 compiler.I have manged to do a configure and a make on the software.But the moment i try to do a make install i get the following:</DIV>
<DIV>install -d /opt/software/bin<BR>install -d /opt/software/share/doc/packages/doxygen<BR>install -m 755 bin/doxygen&nbsp;&nbsp;&nbsp; /opt/software/bin<BR>install -m 755 bin/doxytag&nbsp;&nbsp;&nbsp; /opt/software/bin<BR>install -m 755 bin/doxysearch /opt/software/bin<BR>cp -r doc /opt/software/share/doc/packages/doxygen<BR>cp -r examples /opt/software/share/doc/packages/doxygen<BR>echo "DOXYGEN&nbsp; = /opt/software" &gt;&nbsp; /opt/software/share/doc/packages/doxygen/doc/<BR>Makefile<BR>echo "DOXYDOCS = .."&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &gt;&gt; /opt/software/share/doc/packages/doxygen/doc/Mak<BR>efile<BR>echo "VERSION&nbsp; = 1.2.7" &gt;&gt; /opt/software/share/doc/packages/doxygen/doc/Makefile<BR>cat doc/Makefile.in&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &gt;&gt; /opt/software/share/doc/packages/doxygen/doc/Mak<BR>efile<BR>cd /opt/software/share/doc/packages/doxygen/examples ; /usr/local/bin/make<BR>make[1]: Entering directory `/opt/software/share/doc/packages/doxygen/examples'<BR>/home/smerchant/doxygen/doxygen-1.2.7/bin/doxygen class.cfg<BR>ld.so.1: /home/smerchant/doxygen/doxygen-1.2.7/bin/doxygen: fatal: libstdc++.so.<BR>2.10.0: open failed: No such file or directory<BR>make[1]: *** [class/html/index.html] Killed<BR>make[1]: Leaving directory `/opt/software/share/doc/packages/doxygen/examples'<BR>make: *** [install] Error 2</DIV>
<DIV>&nbsp;</DIV>
<DIV>Can you please tell me what the problem is........I am stuck on this problem for quite a while!</DIV>
<DIV>Thanks</DIV>
<DIV>Shahmil</DIV><br clear=all><hr>Get Your Private, Free E-mail from MSN Hotmail at <a href="http://www.hotmail.com">http://www.hotmail.com</a>.<br></p></html>

Re: [Doxygen-users] EXPAND_AS_DEFINED and Poor Mans Inheritance

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

Hello!

replying to myself...

On Mon, 14 May 2001 09:46:13 +0200, Peter Steiner wrote:

> 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:

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

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

> 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.

Looking at the output of "doxygen -d Preprocessor", the comments stay
where the macro definition was, they are not included into the body of a
macro. Now I did not look into the lex files to provide a patch (i don't
know lex/flex yet), but found a workaround using macros that also
illustrates the problem:

  #define DXY_PASTE(x,y) x ## y
  #define DXY(x)         DXY_PASTE(/,**<) x DXY_PASTE(*,/)

  #define BASECLASS \
      int         aMember;        DXY(Members Doc) \
      /* END OF BASECLASS */

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

Using the DXY macro to get the comments past the lexical analysis seems
to work, but I don't know yet how portable this is for compilers.

It would be nice, if doxygen could handle this itself.

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] Doxygen's doc/translator.pl script update (attached)

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

(This was sent to the Doxygen mailing list and to Dimitri van Heesch 
directly.  The message is related namely to local maintainers.)

As there were some reasons to update the translator.pl script, 
here it is (for the impatient ;-).

 <<trpl.zip>> 
Now, the script recognizes also method prototypes that
do not contain argument identifiers (i.e. they contain the type
of the arguments only).  The wrongly detected details describing
obsolete and missing methods are not listed now (e.g. for
TranslatorGerman).

See you later...

Petr

P.S.	... , aligator,
	After while, crocodile,
	Manana iguana...    
		[Bobby McFerrin]
-- 
Petr Prikryl, SKIL, spol. s r.o., pri...@sk...

[Doxygen-users] Some feedback from a lot of users

[Emilio R. <emi...@ma...>]

Hallo!
I'm introducing doxygen use in my company, and I got 
enthusiastic response from almost all developers; this tool 
is very useful, and performs fine.
All developers gave me some feedback; some are common 
to all of them, so i thought it could be useful to you 
to know about it:

1) A kind of automatic grouping is needed, e.g:
    
    /*! Bit masks for XXXX field: */
    #define MASK1 0x80  /*!< bit meaning... */
    #define MASK2 0x0F  /*!< bits meaning... */

    This should generate a little paragraph with title
    "Bit masks for XXXX field:", or something similar


2) Special additional comments spreaded through 
    all the function body grouped under an automatic 
    tag relative to that funcion documentation, e.g:

    /*!   ...function header...
    */
    void MyFunc(void)
    {
        int i;
        ....

        /*! Developer's notes 1... */
        ....

        /*! Developer's notes 2... */
        ....
    }

    This should generate an additional paragraph
    under MyFunc() documentation, something like:
    ....
    Developer's notes:
      Developer's notes 1...
      Developer's notes 2...

I don't know if these needs are difficult to satisfy, and
surely they are questionable. Anyway I hope these
feedback should be useful to doxygen's developers.

Thank you,
Emilio Riva

RE: [Doxygen-users] Doxygen: Notice for the local maintainers (tr anslator classes)

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

Jens Seidel wrote...
>> [...] You may prefer to put the identifiers back and break the line with
the
>> arument list instead into several lines instead (to make the source text
>> fit inside reasonable column width).
>
> I omit the identifier of the first argument in
>   QCString trFile(bool first_capital, bool singular)
> because I don't need this in translator_de.h. Many german words start with
> a capital, so I get a compiler warning ("unused variable") if I keep it.

Well, I did not think about a reason like that.  Now I see I should
update the script.

Petr

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

[Doxygen-users] Bug reapparing ! And a new one.

[Eric M. <ema...@ne...>]

Hi Dimitri,

this bug reappared in 1.2.8 (maybe even before, I skipped 1.2.6 & 7) :


--- start file okbug2.cpp  (*ok*bug2.cpp 'coz it was fixed...)

/// ns1 dox.
/** Here we get the following warning :
    E:/work/bugsdoxygen/okbug2.cpp:20: Warning: member fct1 of class ns2
cannot be found
 */
namespace  ns1
{
    /// ns2 dox.
    namespace  ns2
    {
        /// fct1 dox.
        void  fct1();
    }
}

namespace ns1
{
    void ns2::fct1()
    {
    }
}

--- end file okbug2.cpp




This is a new one :

I mistyped 'EXPORTDLL' in my doxyfile, and Doxygen went crazy, inventing
new classes :)
Maybe I should get a warning or something that my source is not valid
C++ .
Took me quite some time to find the cause :)

--- start file doxyfile extract

#---------------------------------------------------------------------------
# Configuration options related to the preprocessor   
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
SEARCH_INCLUDES        = YES
INCLUDE_PATH           = 
INCLUDE_FILE_PATTERNS  = 
PREDEFINED             =  "EXPROTDLL="             <<< when mistyped,
Doxygen goes crazy
EXPAND_AS_DEFINED      = 

--- end file doxyfile extract


--- start file bug5.h

/// cClass5 dox.
class  EXPORTDLL  cClass5
{
private:
    class  cIMP;
    cIMP*  m;  ///< The implementation.
};

--- end file bug5.h


--- start file bug5.cpp

#include "bug5.h"

/// Some base class.
class  cBase5
{
};

/// cIMP dox.
class  EXPORTDLL  cClass5::cIMP :
    public  cBase5
{
public:
    int  mMember; ///< A member.
};

--- end file bug5.cpp



Thank you for your time and Doxygen !

-- 
Eric Matecki

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

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

On Tue, Jun 05, 2001 at 10:22:52AM +0100, Luigi Ballabio wrote:
> At 05:11 PM 6/4/01 +0200, Dimitri van Heesch wrote:
> >Hi,
> >
> >Another official release is out. Here is what has changed since last update:
> >--------------------------------------------------------------------------
> >+ BUG: Fixed a problem with argument matching for arguments that contained
> >        classes imported via a using declaration.
> >--------------------------------------------------------------------------
> 
> Dimitri,
>          the above is not entirely true. The following code still triggers 
> the problem.

The statement is true, since it didn't say that *all* problems would be
fixed :-)

Anyway, I'll look into your example.

Regards,
  Dimitri

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

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

On Tue, Jun 05, 2001 at 04:17:38AM +0200, Jens Seidel wrote:
> 
> 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

This is a serious bug indeed. It will probably lead to 
bug fix release 1.2.8.1 soon.

> 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

I'll fix that as well.

Regards,
  Dimitri

Re: [Doxygen-users] Doxygen: Notice for the local maintainers (translator classes)

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

On Tue, 5 Jun 2001, Prikryl,Petr wrote:

> Please, try to generate documentation via doxygen/doc/Makefile,
> or run the perl script translator.pl manually.  Then, have a look at
> doxygen/doc/translator_report.txt.  There may be notices which
> can help you to clean your translator_xx.h source even in the case
> when your translator class is marked as up-to-date.
>
> Notice, that if you removed argument identifiers from the method headers
> (i.e. you leave only type identifiers there), the method is not recognized.
> You may prefer to put the identifiers back and break the line with the
> arument list instead into several lines instead (to make the source text
> fit inside reasonable column width).
>

I omit the identifier of the first argument in
  QCString trFile(bool first_capital, bool singular)
because I don't need this in translator_de.h. Many german words start with
a capital, so I get a compiler warning ("unused variable") if I keep it.

Petr can you update your script to recognize this?

Jens

[Doxygen-users] Doxygen: Notice for the local maintainers (translator classes)

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

Please, try to generate documentation via doxygen/doc/Makefile,
or run the perl script translator.pl manually.  Then, have a look at 
doxygen/doc/translator_report.txt.  There may be notices which
can help you to clean your translator_xx.h source even in the case
when your translator class is marked as up-to-date.

Notice, that if you removed argument identifiers from the method headers
(i.e. you leave only type identifiers there), the method is not recognized.
You may prefer to put the identifiers back and break the line with the
arument list instead into several lines instead (to make the source text
fit inside reasonable column width). 

As the translator.pl is only auxiliar tool, as there is only about 
20 local maintainers, and as its result is not needed by usual Doxygen
users, the better recognition of both the obsolete and not implemented
methods is not planned in the above mentioned sense.

Thanks for you precious time,

Petr

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

Re: [Doxygen-users] Re: files order

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

Stephen Goudge wrote:
> looking through some archived messages, I thought this was worth re-posting:
> 
> > -----Original Message-----
> > From: Jani Kajala [mailto:jan...@re...]
> > Sent: 17 November 2000 09:05
> > To: Doxygen Mailing List
> > Subject: Structuring documentation
> >
> > Hope this example clarifies a bit:
> >
> > SDK Documentation
> >     +- What's New
> >     |   |- Legal Information
> >     |   |- Release Notes
> >     |   \- About SDK
> >     |
> >     +- Used Conventions
> >     +- Reference Manual
> >     |   +- About Reference Manual
> >     |   +- Class Reference
> >     |        +- Class A
> >     |        +- Class B
> >     +- ...

That is precisely what we want to do.
Anyone has a clue about how this could be achieved easily?
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...

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

[Luigi B. <lui...@ri...>]

At 05:11 PM 6/4/01 +0200, Dimitri van Heesch wrote:
>+ BUG: Fixed a problem with argument matching for arguments that contained
>        classes imported via a using declaration.

Another possibly related glitch: a "no matching class member found" warning 
is issued for any method of a class defined inside an anonymous namespace 
inside another namespace, as in the following code.

Thanks again,
                 Luigi

---- test.cpp ----


namespace A {

     namespace {

         class A {
           public:
             A() {}
             void g() {}
         };

     }

}

--------

RE: [Doxygen-users] Re: files order

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

Replying to my own message:

> -----Original Message-----
> From: dox...@li...
> [mailto:dox...@li...]On Behalf Of Stephen
> Goudge
> Sent: 05 June 2001 09:43
> To: dox...@li...
> Subject: [Doxygen-users] Re: files order
> 
> 
> It is true that the HTML output can be accessed in any order, 
> but it can still
> be useful to have a 'natural reading order'. It is an advantage of any
> hyper-linked document that you can leap around, but you still 
> benefit from being
> able to refer back to a structured overview.
<snip>

looking through some archived messages, I thought this was worth re-posting:

> -----Original Message-----
> From: Jani Kajala [mailto:jan...@re...]
> Sent: 17 November 2000 09:05
> To: Doxygen Mailing List
> Subject: Structuring documentation
> 
> 
> Hi all,
> 
> How can I define the structure of the documentation with Doxygen?
> 
> So far I've only managed to produce individual pages and link 
> them \refs. This is fine for HTML but not for more book-like 
> output formats (like for example RTF). So what I'm seeking 
> for is a way to write hierarchical (Chapter 1, Chapter 1.1, 
> ...) manual (with class documentation and individual pages 
> 'inserted' to it). But I just can't find a way how to define 
> relative order of pages and the documentation structure in general.
> 
> Hope this example clarifies a bit:
> 
> SDK Documentation
>     +- What's New
>     |   |- Legal Information
>     |   |- Release Notes
>     |   \- About SDK
>     |
>     +- Used Conventions
>     +- Reference Manual
>     |   +- About Reference Manual
>     |   +- Class Reference
>     |        +- Class A
>     |        +- Class B
>     +- ...
> 
> Hope somebody can help. I haven't used Doxygen that much yet, 
> but I've liked many features so far (for example convenient 
> \ref, \b, \c etc. tags are really nice). I do have used a lot 
> of documentation generators before though, Doc++, CCDoc, 
> JavaDoc, Object Outline, ...
> 
> 
> Regards,
> Jani Kajala

[Doxygen-users] Re: files order

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

It is true that the HTML output can be accessed in any order, but it can still
be useful to have a 'natural reading order'. It is an advantage of any
hyper-linked document that you can leap around, but you still benefit from being
able to refer back to a structured overview.

To that end, Angela's request just scratches the surface :-)

The documentation for a library - in particular - consists of a lot more than
just the API documentation (which Doxygen excels at). Coming to the docs for the
first time, whether using online (HTML) or printed versions, a user has to be
able to find out what the library is intended to do, have a structured
walk-through from "this is how to use the library in the simplest way" and
introducing the functionality in a 'sensible' order.

Then there are the ancillary details, such as file formats, that the library as
a whole manipulates; if these include, say, an XML-based configuration format
then there is a need for a set of examples to illustrate using that format.

You can patch together something that almost works - for example, using lots of
extra pages and \ref's; the mainpage can be carefully structured to act as a
contents page. Doing this by hand has a number of problems, including:

- it is a lot of work even to do even simply!

- the structure is not reflected in any of the lists that Doxygen generates, so
selecting the 'examples' link from the menu does not present any obvious
starting point. Looking at the 'related pages' list is sometimes not much help
either.


There is a very great advantage to using Doxygen for worked examples: the code
fragments shown in the docs are taken directly from complete  sample programs,
which are available to the reader to compile and run. By putting the examples
into the Makefiles along with the library itself you are guaranteed that the
examples are up to date and do, indeed, compile.

What I'd like to be able to do is something structured like - just to pick the
most recent example I have to hand - a combination of  the O'Reilly "Java in a
Nutshell" and "Java Examples in a Nutshell" books (but for much smaller
libaries, I hasten to add; still an ambitious goal :-)

Perhaps if one thought about what something like a "Tex to HTML" converter does
(in terms of taking an already structured document and making it browseable) and
consider what could be added to Doxygen to let it (at the user's discretion, of
course) add some structure to the discourse portion of program documentation?

Stephen Goudge

> -----Original Message-----
> From: dox...@li...
> [mailto:dox...@li...]On Behalf Of Wagner,
> Victor
> Sent: 04 June 2001 15:25
> To: 'dox...@li...'
> Subject: RE: [Doxygen-users] Re: files order
>
>
> 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 mailing list
> Dox...@li...
> http://lists.sourceforge.net/lists/listinfo/doxygen-users
>

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

[Luigi B. <lui...@ri...>]

At 05:11 PM 6/4/01 +0200, Dimitri van Heesch wrote:
>Hi,
>
>Another official release is out. Here is what has changed since last update:
>--------------------------------------------------------------------------
>+ BUG: Fixed a problem with argument matching for arguments that contained
>        classes imported via a using declaration.
>--------------------------------------------------------------------------

Dimitri,
         the above is not entirely true. The following code still triggers 
the problem.

Thanks anyway,
                         Luigi

---- test.hpp ----

namespace A {

     namespace B {

         class B1 {};

     }

     namespace C {

         class C1 {
           public:
             C1(B::B1 b);
         };

         class C2 {
           public:
             C2(const B::B1& b);
         };

     }

}

---- test.cpp ----

#include "test.hpp"

namespace A {

     using B::B1;

     namespace C {

         C1::C1(B1 b) {}

     }

}

--------

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

[Alessandro F. <afa...@da...>]

> 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)?

I can answer to this!
In old docs it was something like:
"Supports C++, Java, IDL (Corba, Microsoft, Java and KDE-DCOP flavors) and C
sources"
so the wording inside the brackets refer to IDL

I do not know what's KDE-DCOP is but I imagine is a variant of the IDL to
specify interfaces used by an object communication protocol inside KDE
Desktop Environment.

CORBA is the acronym for Common Object Request Broker Architecture and is a
cross-platform and cross-language architecture (of course) for distributed
object computing. More infos at www.omg.org.

Alessandro