doxygen-users — List for users of doxygen

[Doxygen-users] Documenting command lines options

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

My project includes a shell like command line processor with commands in the 
ususal unix command line format. eg.

command -a -bvalue

I'd like to document them using doxygen and incorporate them into the rest of 
my docs. I have two questions.

Are there any options available for assisting in documenting such commands 
something like the following

/*! \page command.html command description
\command command -a -bvalue
\param -a Does whatever -a does
\param -bvalue Does whatever -b value does

Long Description of command

\sa othercommand, yetanothercommand
*/

Secondly if I want a section to describe all these commands, one command per 
page, I can create each page with the \page command but then each commands 
page shows up in the related docs section. I'd prefer only the top level page 
giving an overview fo the commands and links to the other pages to appear 
there. Is this possible.

Thanks

Bob S.

[Doxygen-users] Doxygen-1.2.10-20010909 in CVS

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

Hi,

I have just committed the following changes to the CVS repository:
-------------------------------------------------------------------------
+ ADD: The source browser option now generates links to (documented)
       globals and fields. Especially useful for C code.
+ ADD: Input containing CR+LF (DOS/Windows) or CR only (Mac) are now
       automatically converted to LF.
+ ADD: New config option SKIP_FUNCTION_MACROS that when set to YES
       (the default) makes doxygen's preprocessor automatically remove all
       function macros that are alone on a line and do not end with a
       semicolon. These are typically used as boiler plate code and
       confuse the parser if not removed.
+ ADD: Added class collaboration and inheritance diagram descriptions
       to the XML output. Also added source browser output for each file.
+ ADD: Added a developers part to the manual, with some information on
       how doxygen is structured internally.
+ CHG: Undocumented friend class declarations now link to their class
       if documented.
+ CHG: Undocumented template classes are now shown in the collaboration
       diagram.
+ BUG: Using HIDE_UNDOC_MEMBERS=YES and ENUM_VALUES_PER_LINE=1 resulted in
       blank lines in the HTML-output.
+ BUG: "friend class A::B" caused a bogus warning.
+ BUG: Fixed problem generating tag files for the Qt-3.0.0 beta releases.
+ BUG: Fixed parameter list layout problem in the HTML output.
+ BUG: Fixed some (all?) compile problems on Solaris.
+ BUG: Class hierarchy was not correct if a template class inherited from
       a template argument, which was also a documented class.
+ BUG: When substituting template arguments, default values of
       template arguments were not substituted themselves.
-------------------------------------------------------------------------
Enjoy,
  Dimitri

[Doxygen-users] (no subject)

[Jose L. Z. <jlz...@ca...>]

-- 
José Luis Zabalza
jlz...@ca...
Linux User 172551

[Doxygen-users] PROJECT_NAME not found, but its there?

[Joshua P. <jp...@ei...>]

Hello, I'm getting the following error when I run doxygen:

Error: tag INPUT: input source `PROJECT_NAME' does not exist

But here is the first few lines of my Doxygen file:

# Doxyfile 0.1

#---------------------------------------------------------------------------
# General configuration options
#---------------------------------------------------------------------------
PROJECT_NAME           = "Visualizer Library"
PROJECT_NUMBER         = 0.5
OUTPUT_DIRECTORY       = "C:/Development/Visualizer/Documentation/"
OUTPUT_LANGUAGE        = English
EXTRACT_ALL            = YES

Is there any explaination for this? Thanks!

[Doxygen-users] DISABLE_INDEX Option

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

Specified DISABLE_INDEX=YES and provide my own navigation bar in my
customized header.html.  All find and good.  The problem is that with this
option specified, doxygen modifies the main page to contain the data that was
on the old bar.  I don't want the index but I also want the old blank main
page.  Can I do this?

On a related note, if I use the \mainpage command, will that suppress
doxygen's main page and only print what I've specified?  I'd rather not have
to do this.

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

Re: [Doxygen-users] Specifying #defines *not* to expand

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

On Wed, Sep 05, 2001 at 04:51:13PM +0200, John Sturton wrote:
> Hello all,
> 
> Is it somehow possible to give a list (or preferably a regexp) of
> preprocessor #defines that Doxygen should *not* expand?

For a macro A defining:

PREDEFINED = A=A

should prevent normal expansion. 
But no regexps I'm afraid.

Regards,
  Dimitri

[Doxygen-users] Specifying #defines *not* to expand

[John S. <joh...@se...>]

Hello all,

Is it somehow possible to give a list (or preferably a regexp) of
preprocessor #defines that Doxygen should *not* expand?

Cheers,

John Sturton

RE: [Doxygen-users] Mid function special commands (like @todo)?

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

No commands from inside a function body is interpreted.
Add your @todo to the doxygen comment placed just above 
or just below the function header -- depending on your style.

I would do something like this:

/*! \brief Calculates something.

  The MemberFn() calculates something using well known 
  algorithm. 

  \param i This is the argument of the function which...
  
@todo verify physical constants
@todo obfuscate the constants meaningOfLife = 42

*/
void SomeClass::MemberFn(int i)
{
  // calculate some stuff
  float pi = 3.14f;
  float e = 2.71f;
  int meaningOfLife = 42;
  int mahabone = 13;
  // some more stuff
}

Note: the @todo and \todo is the same. I personally prefer
the second way because of my previous LaTeX experience.

Petr

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

> -----Original Message-----
> From:	Cory Riddell [SMTP:co...@co...]
> Sent:	Wednesday, September 05, 2001 3:22 PM
> To:	dox...@li...
> Subject:	[Doxygen-users] Mid function special commands (like @todo)?
> 
> What happens to special commands that do not immediately precede a 
> function or member?  For example:
> 
> void SomeClass::MemberFn(int i)
> {
>   // calculate some stuff
>   /// @todo verify physical constants
>   float pi = 3.14f;
>   float e = 2.71f;
>   /// @todo obfuscate the following constants
>   int meaningOfLife = 42;
>   int mahabone = 13;
>   // some more stuff
> }
> 
> I've looked at the doxygen output and I don't see the todo list 
> anywhere.  Does the todo item have to be documented just before the 
> function definition?  Is there a configuration switch that will tell 
> doxygen to extract mid-function todo's?
> 
> -cory
> 
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Mid function special commands (like @todo)?

[Cory R. <co...@co...>]

What happens to special commands that do not immediately precede=
 a 
function or member?  For example:

void SomeClass::MemberFn(int i)
{
  // calculate some stuff
  /// @todo verify physical constants
  float pi =3D 3.14f;
  float e =3D 2.71f;
  /// @todo obfuscate the following constants
  int meaningOfLife =3D 42;
  int mahabone =3D 13;
  // some more stuff
}

I've looked at the doxygen output and I don't see the todo list 
anywhere.  Does the todo item have to be documented just before=
 the 
function definition?  Is there a configuration switch that will=
 tell 
doxygen to extract mid-function todo's?

-cory

Re: [Doxygen-users] best ways of getting images into generated outputs

[Volker B. <boe...@we...>]

On Tue, 4 Sep 2001, John Clinton wrote:

> What should I do if I had an image file (.gif, .png, .jpg,
> etc.) and wanted to have some Doxygen comment in my source
> code cause that image to be displayed in the generated output?
> 
> Ideally I want to have the imaged display in both LaTeX (which
> I convert to .pdf) and HTML.  I know for HTML only I could
> include an HTML <IMG> tag, but that doesn't help LaTeX.

For bitmap-graphics I use PNG only (small size, portable), example:

  @image html billing_ext_arch.png
  @latexonly \begin{center} @endlatexonly
    @image latex billing_ext_arch.png width=10cm
  @latexonly \end{center} @endlatexonly

Unfortunately this doesn't work with the dvips driver of the graphicx
package, so you can't generate a dvi file from the code above. And even
the following will not work:

 $ cd latex
 $ make pdf

Since this only converts the dvi to pdf (via ps).
The only way is to use pdflatex:

 $ cd latex
 $ pdflatex refman

(Dimitri, perhaps you could add a 'pdflatex' target to the Makefile in the
generated latex directory.)

The alternative for latex is converting the bitmaps to EPS, but this costs
disk space and maintenance effort.

Regards,
Volker
-- 
Volker Boerchers, boe...@we...

Re: [Doxygen-users] best ways of getting images into generated outputs

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

What about looking in the commands section of the doxygen manual :-)

You have to use the \image command which has to be used for every output 
format you want to produce.

---
Gruß

Berno


Am Wednesday 05 September 2001 00:15 schrieben Sie:
> What should I do if I had an image file (.gif, .png, .jpg,
> etc.) and wanted to have some Doxygen comment in my source
> code cause that image to be displayed in the generated output?
>
> Ideally I want to have the imaged display in both LaTeX (which
> I convert to .pdf) and HTML.  I know for HTML only I could
> include an HTML <IMG> tag, but that doesn't help LaTeX.
>
> Any thoughts on good options??
>
> Thanks,
>
> --John
> j.c...@ar...

[Doxygen-users] \htmlonly, \latexonly etc.

[Christoph K. <ko...@in...>]

Hi.

I have encountered a problem with the use of \htmlonly and \latexonly (at least I
perceive it as a problem). I wrote a class documentation that was somewhat formula-
heavy. I want to use the "pass-through" capability of Doxygen (via \latexonly) to
have "good-looking" formulae in the LaTeX output. The problem is that
the part between \latexonly and \endlatexonly is a not replacement but a supplement.
If I want a textual approximation of the formula-heavy part to appear in the HTML
output I have to use \htmlonly ... \endhtmlonly for that. But then the manpage output
(and also the RTF output, I suppose, but I didn't explicitly check) has neither the
\latexonly nor the \htmlonly part. What to do? Either add \xxxonly and \endxxxonly
for every output format xxx, or invent something like

\latexonly
<The LaTeX specific part>
\htmlonly
<The HTML specific part>
\otherformats
<The default part, valid for the formats that were not explicitly mentioned before>
\endlatexonly

or

\htmlonly
<The HTML part>
\otherformats
<Default part>
\endhtmlonly

I. e., some \xxxonly part goes as far as the next \yyyonly, \otherformats, or
\endxxxonly tag is encountered.
Do I make any sense at all? Is there already a way to achieve what I want?

Cheers, Christoph
-- 
================================================================================
Christoph Koegl, Dept. of Computer Science, University of Kaiserslautern

E-Mail: christoph at familie-koegl dot de
WWW: http://www dot familie-koegl dot de/
--------------------------------------------------------------------------------
There are no stupid questions, but there are a LOT of inquisitive idiots.
--------------------------------------------------------------------------------

RE: [Doxygen-users] best ways of getting images into generated ou tputs

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

Look for \latexonly, \endlatexonly, \htmlonly, and \endhtmlonly commands
in the documentation.  Then you can use a pair of commands: one for
HTML with one filename, the second for LaTeX with another filename.

This should work in principle, but I did not try it.  There possibly can
be better way (I do not know).

See you,
  Petr

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

> -----Original Message-----
> From:	John Clinton [SMTP:j.c...@ar...]
> Sent:	Wednesday, September 05, 2001 12:15 AM
> To:	dox...@li...
> Subject:	[Doxygen-users] best ways of getting images into generated
> outputs
> 
> What should I do if I had an image file (.gif, .png, .jpg,
> etc.) and wanted to have some Doxygen comment in my source
> code cause that image to be displayed in the generated output?
> 
> Ideally I want to have the imaged display in both LaTeX (which
> I convert to .pdf) and HTML.  I know for HTML only I could
> include an HTML <IMG> tag, but that doesn't help LaTeX.
> 
> Any thoughts on good options??
> 
> Thanks,
> 
> --John
> j.c...@ar...
> 
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] best ways of getting images into generated outputs

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

What should I do if I had an image file (.gif, .png, .jpg,
etc.) and wanted to have some Doxygen comment in my source
code cause that image to be displayed in the generated output?

Ideally I want to have the imaged display in both LaTeX (which
I convert to .pdf) and HTML.  I know for HTML only I could
include an HTML <IMG> tag, but that doesn't help LaTeX.

Any thoughts on good options??

Thanks,

--John
j.c...@ar...

Re: [Doxygen-users] Problem with linking macros using the \retval tag

[keith b. <ban...@ho...>]

I had the same problem as Alexander with the #IDENTIFIER
not working under \retval. I never found any way to make it work.
Is there a fix planned for this?


>Hi,
>
>I would like to report a  problem with linking macros using the \retval tag
>(Doxygen version is 1.2.9.1). I have a set of error return codes which I
>documented as follows in my .C file:
>/*!
>* . . . (other tags)
>*
>* \retval  #ERROR_CODE1
>* \retval  #ERROR_CODE2
>* \retval  #ERROR_CODE3
>* . . .  (other codes)
>*/
>where ERROR_CODE? are defined in a separate .h file. According to
>documentation, adding '#' should link a macro to its definition. And it
>works fine with \note, \warning, \param, etc. except for the \retval. If I
>put a linked macro from e.g. \note into the \retval, the link is not
>working anymore.
>  I would be very grateful if somebody can help me with this problem or, if
>it is a bug, fix it. Thank you.
>
>Regards,
>Alexander Abrashkevich
>
>
>_______________________________________________
>Doxygen-users mailing list
>Dox...@li...
>https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
>


_________________________________________________________________
Get your FREE download of MSN Explorer at http://explorer.msn.com/intl.asp

[Doxygen-users] Problem with linking macros using the \retval tag

[<aab...@ca...>]

Hi,

I would like to report a  problem with linking macros using the \retval tag
(Doxygen version is 1.2.9.1). I have a set of error return codes which I
documented as follows in my .C file:
/*!
* . . . (other tags)
*
* \retval  #ERROR_CODE1
* \retval  #ERROR_CODE2
* \retval  #ERROR_CODE3
* . . .  (other codes)
*/
where ERROR_CODE? are defined in a separate .h file. According to
documentation, adding '#' should link a macro to its definition. And it
works fine with \note, \warning, \param, etc. except for the \retval. If I
put a linked macro from e.g. \note into the \retval, the link is not
working anymore.
 I would be very grateful if somebody can help me with this problem or, if
it is a bug, fix it. Thank you.

Regards,
Alexander Abrashkevich

[Doxygen-users] Stylesheets / Headers / Footers

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

I tried, for the first time, to customize these options.

1) Although I specified  "HTML_STYLESHEET = stylesheet.css", the generated
   HTML are referencing doxygen.css.  A bug, no?

2) Is there a way to make the header/footer inclusion dynamic?  This way I
   can change the header/footer and see the results without having to do a
   complete doxygen reprocessing of my code.  Right now the text of the
   header/footer are hard-coded into each file.

This is with doxygen 1.2.10.

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

Re: [Doxygen-users] Compile Problems with latest CVS version

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

The xmlgen.cpp compilation errors are caused by the "static" keyword on the
sectionTypeToString and writeXMLLink functions.  If they are not "static" it
compiles fine.

    Jake> 2) Compile errors, not esily fixed (by me):

    Jake> "xmlgen.cpp", line 354: Error: The name
    Jake> sectionTypeToString(BaseOutputDocInterface::SectionTypes) is
    Jake> unusable in
    Jake> XMLGenerator::startDescList(BaseOutputDocInterface::SectionTypes).
    Jake> "xmlgen.cpp", line 439: Error: The name writeXMLLink(QTextStream&,
    Jake> const char*, const char*, const char*) is unusable in
    Jake> XMLGenerator::writeCodeLink(const char*, const char*, const char*,
    Jake> const char*).  "xmlgen.cpp", line 427: Error: The name
    Jake> writeXMLLink(QTextStream&, const char*, const char*, const char*)
    Jake> is unusable in XMLGenerator::writeObjectLink(const char*, const
    Jake> char*, const char*, const char*).  "xmlgen.cpp", line 97: Error:
    Jake> The name writeXMLLink(QTextStream&, const char*, const char*, const
    Jake> char*) is unusable in TextGeneratorXMLImpl::writeLink(const char*,
    Jake> const char*, const char*, const char*) const.  4 Error(s) detected.

-- 
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 mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

-- 
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] STL containers in collaboration graphs

[Matej K. <mat...@he...>]

Hi,

Is it possible to configure doxygen to show vectors, maps etc in
collaboration graphs?

For instance:

I have a class called val_Element.
I have another class val_List, which has vector<val_Element> m_list as its
member.

m_list is not shown in collaboration diagram.

However, val_Element m_elem would be shown as well as
my_template_vector<val_Element>.

Do I have to include STL headers to the doxygen project?
Are there any other (simpler) solutions?

TIA,

Matej

[Doxygen-users] Compile Problems with latest CVS version

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

Dimitri,

Two compile problems so far, using platform solaris-cc:

1) entry.h at line 219 has an extraneous comma.  This is a fatal compile
   error that is easily fixed by deleting the comma.

2) Compile errors, not esily fixed (by me):

"xmlgen.cpp", line 354: Error: The name sectionTypeToString(BaseOutputDocInterface::SectionTypes) is unusable in XMLGenerator::startDescList(BaseOutputDocInterface::SectionTypes).
"xmlgen.cpp", line 439: Error: The name writeXMLLink(QTextStream&, const char*, const char*, const char*) is unusable in XMLGenerator::writeCodeLink(const char*, const char*, const char*, const char*).
"xmlgen.cpp", line 427: Error: The name writeXMLLink(QTextStream&, const char*, const char*, const char*) is unusable in XMLGenerator::writeObjectLink(const char*, const char*, const char*, const char*).
"xmlgen.cpp", line 97: Error: The name writeXMLLink(QTextStream&, const char*, const char*, const char*) is unusable in TextGeneratorXMLImpl::writeLink(const char*, const char*, const char*, const char*) const.
4 Error(s) detected.

Thanks!

...Jake

-- 
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] 1.2.10 slower than 1.2.5 on Irix?

[<mwi...@ab...>]

<html>
Hi<br>
<br>
At my company we have until recently been using 1.2.5 with great success
on a large multimillion line codebase. Recently we upgraded to 1.2.10,
but find that the documentation build takes significantly longer (around
four days as opposed to around 24 hours previously) and this is such a
problem for us that we may need to downgrade back to 1.2.5. Has anyone
else observed this?<br>
<br>
cheers, Malcolm<br>
<br>
<x-sigsep><p></x-sigsep>
<hr>
<font size=4 color="#000080"><b>Malcolm Wilkins
</font><font color="#000080">&nbsp;&nbsp;
</font><font size=2 color="#000080">&nbsp;
</b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<br>
<div align="right">
<b>Schlumberger GeoQuest<br>
</b></font><font size=1 color="#008080"><i>Simulation Software
Development<br>
11 Foxcombe Court<br>
Wyndyke Furlong<br>
Abingdon, OXON OX14 1DZ<br>
</i></font><font size=1>01235 543443<br>
<hr>
</font></div>
<br>
</html>

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

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

It's working fine for me now.  

Thanks,

Jeff

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

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

On Mon, Sep 03, 2001 at 09:57:04AM +0200, Dimitri van Heesch wrote:
> On Sun, Sep 02, 2001 at 11:41:00PM +0200, Roberto Bagnara wrote:
> > 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,
> 
> This problem should be solved now.

For those who still have problems downloading the files, I've now mirrored
them at http://doxygen.sourceforge.net/dl/

Regards,
  Dimitri

Re: [Doxygen-users] doxytag & qt 3.0

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

On Fri, Aug 31, 2001 at 08:48:37AM +0200, Xander Burgerhout wrote:
> 
> 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?

The HTML format has apparently changed. I'll adjust doxytag's scanner 
to make it work again.

Regards,
  Dimitri

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

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

On Sun, Sep 02, 2001 at 11:41:00PM +0200, Roberto Bagnara wrote:
> 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,

This problem should be solved now.

Regards,
  Dimitri