doxygen-users — List for users of doxygen

[Doxygen-users] sretni praznici

[Boris B. <bor...@zg...>]

Sretan Božić i Novu Godinu
žele vam
Helena , Anamarija i Boris

RE: [Doxygen-users] include graph

[Paul B. <pee...@ya...>]

--- John Bergman <Jo...@zo...> wrote:
> The .GIF files should contain the actual graphs
> right?  Try opening and
> viewing one of them to be sure they are being
> generated properly (at least)

Hmmm, the GIF files are all inheritance graphs, or 
individual class names in boxes - there are no
include dependency graphs.

Paul.


__________________________________________________
Do You Yahoo!?
Check out Yahoo! Shopping and Yahoo! Auctions for all of
your unique holiday gifts! Buy at http://shopping.yahoo.com
or bid at http://auctions.yahoo.com

RE: [Doxygen-users] include graph

[Paul B. <pee...@ya...>]

> --- John Bergman <Jo...@zo...> wrote:
> > You need to get the graphviz package and install
> it.
> >  Then be sure to add it
> > to the path.
> 

Thanks although I think (?) I have all that covered.
At least I have HAVE_DOT set to YES, and all the 
following are in my path -

  dot*     dotty*   lefty*   lneato*  neato*

There don't seem to be any doxygen files with
filenames which include the word 'Include' in my html
directory (see below).
 
Do I have to instrument the include files with 
any doxygen keywords to ensure they are found for
the graph?

Thanks again for any help,
Paul.




 ls -l html/
 total 433
 -rw-r--r--    1 pab      staff       4493 Dec 20
 16:19
 Vl__CalibObjectGuideData_8H-source.html
 -rw-r--r--    1 pab      staff       4848 Dec 20
 16:19
 Vl__CalibObjectImageData_8H-source.html
 -rw-r--r--    1 pab      staff       3777 Dec 20
 16:19
 Vl__CalibObjectWorldData_8H-source.html
 -rw-r--r--    1 pab      staff      10322 Dec 20
 16:19
 Vl__CalibObject_8H-source.html
 -rw-r--r--    1 pab      staff      12189 Dec 20
 16:19
 Vl__CalibPlane_8H-source.html
 -rw-r--r--    1 pab      staff       4164 Dec 20
 16:19
 Vl__PatternGuideData_8H-source.html
 -rw-r--r--    1 pab      staff       6776 Dec 20
 16:19
 Vl__PatternImageData_8H-source.html
 -rw-r--r--    1 pab      staff       7327 Dec 20
 16:19
 Vl__PatternWorld2dData_8H-source.html
 -rw-r--r--    1 pab      staff      11480 Dec 20
 16:19
 Vl__PatternWorld3dData_8H-source.html
 -rw-r--r--    1 pab      staff       3599 Dec 20
 16:19
 Vl__PatternWorldData_8H-source.html
 -rw-r--r--    1 pab      staff       2100 Dec 20
 16:19
 annotated.html
 -rw-r--r--    1 pab      staff       4146 Dec 20
 16:19
 classVl__CalibObjectGuideData-members.html
 -rw-r--r--    1 pab      staff       3534 Dec 20
 16:19
 classVl__CalibObjectGuideData.html
 -rw-r--r--    1 pab      staff       4433 Dec 20
 16:19
 classVl__CalibObjectImageData-members.html
 -rw-r--r--    1 pab      staff       3521 Dec 20
 16:19
 classVl__CalibObjectImageData.html
 -rw-r--r--    1 pab      staff       3364 Dec 20
 16:19
 classVl__CalibObjectWorldData-members.html
 -rw-r--r--    1 pab      staff       4723 Dec 20
 16:19
 classVl__CalibObjectWorldData.html
> -rw-r--r--    1 pab      staff       3692 Dec 20
> 16:19
> classVl__PatternGuideData-members.html
> -rw-r--r--    1 pab      staff       3024 Dec 20
> 16:19
> classVl__PatternGuideData.html
> -rw-r--r--    1 pab      staff       6106 Dec 20
> 16:19
> classVl__PatternImageData-members.html
> -rw-r--r--    1 pab      staff       4487 Dec 20
> 16:19
> classVl__PatternImageData.html
> -rw-r--r--    1 pab      staff       7496 Dec 20
> 16:19
> classVl__PatternWorld2dData-members.html
> -rw-r--r--    1 pab      staff       6405 Dec 20
> 16:19
> classVl__PatternWorld2dData.html
> -rw-r--r--    1 pab      staff       2095 Dec 20
> 16:19
> classVl__PatternWorld2dData__coll__graph.gif
> -rw-r--r--    1 pab      staff       2095 Dec 20
> 16:19
> classVl__PatternWorld2dData__inherit__graph.gif
> -rw-r--r--    1 pab      staff      13622 Dec 20
> 16:19
> classVl__PatternWorld3dData-members.html
> -rw-r--r--    1 pab      staff       9515 Dec 20
> 16:19
> classVl__PatternWorld3dData.html
> -rw-r--r--    1 pab      staff       2098 Dec 20
> 16:19
> classVl__PatternWorld3dData__coll__graph.gif
> -rw-r--r--    1 pab      staff       2098 Dec 20
> 16:19
> classVl__PatternWorld3dData__inherit__graph.gif
> -rw-r--r--    1 pab      staff       3708 Dec 20
> 16:19
> classVl__PatternWorldData-members.html
> -rw-r--r--    1 pab      staff       3976 Dec 20
> 16:19
> classVl__PatternWorldData.html
> -rw-r--r--    1 pab      staff       3663 Dec 20
> 16:19
> classVl__PatternWorldData__inherit__graph.gif
> -rw-r--r--    1 pab      staff       1180 Dec 20
> 16:19
> doxygen.css
> -rw-r--r--    1 pab      staff       2378 Dec 20
> 16:19
> doxygen.gif
> -rw-r--r--    1 pab      staff       2401 Dec 20
> 16:19
> files.html
> -rw-r--r--    1 pab      staff       1500 Dec 20
> 16:19
> functions.html
> -rw-r--r--    1 pab      staff       2015 Dec 20
> 16:19
> graph_legend.dot
> -rw-r--r--    1 pab      staff      11788 Dec 20
> 16:19
> graph_legend.gif
> -rw-r--r--    1 pab      staff       4392 Dec 20
> 16:19
> graph_legend.html
> -rw-r--r--    1 pab      staff       1882 Dec 20
> 16:19
> hierarchy.html
> -rw-r--r--    1 pab      staff        989 Dec 20
> 16:19
> index.html
> -rw-r--r--    1 pab      staff        645 Dec 20
> 16:19
> inherit__graph__0.gif
 -rw-r--r--    1 pab      staff        920 Dec 20
 16:19
 inherit__graph__1.gif
 -rw-r--r--    1 pab      staff        932 Dec 20
 16:19
 inherit__graph__2.gif
 -rw-r--r--    1 pab      staff        936 Dec 20
 16:19
 inherit__graph__3.gif
 -rw-r--r--    1 pab      staff        611 Dec 20
 16:19
 inherit__graph__4.gif
 -rw-r--r--    1 pab      staff        780 Dec 20
 16:19
 inherit__graph__5.gif
 -rw-r--r--    1 pab      staff        785 Dec 20
 16:19
 inherit__graph__6.gif
 -rw-r--r--    1 pab      staff       3024 Dec 20
 16:19
 inherit__graph__7.gif
 -rw-r--r--    1 pab      staff       2993 Dec 20
 16:19



__________________________________________________
Do You Yahoo!?
Check out Yahoo! Shopping and Yahoo! Auctions for all of
your unique holiday gifts! Buy at http://shopping.yahoo.com
or bid at http://auctions.yahoo.com

RE: [Doxygen-users] include graph

[Paul B. <pee...@ya...>]

--- John Bergman <Jo...@zo...> wrote:
> You need to get the graphviz package and install it.
>  Then be sure to add it
> to the path.

Thanks although I think (?) I have all that covered.
At least I have HAVE_DOT set to YES, and all the 
following are in my path -

  dot*     dotty*   lefty*   lneato*  neato*

There don't seem to be any doxygen files with
filenames
which include the word 'Include' in my html directory
(see below).

Do I have to instrument the include files with 
any doxygen keywords to ensure they are found for the
graph?

Thanks again for any help,
Paul.



 ls -l html/
total 433
-rw-r--r--    1 pab      staff       4493 Dec 20 16:19
Vl__CalibObjectGuideData_8H-source.html
-rw-r--r--    1 pab      staff       4848 Dec 20 16:19
Vl__CalibObjectImageData_8H-source.html
-rw-r--r--    1 pab      staff       3777 Dec 20 16:19
Vl__CalibObjectWorldData_8H-source.html
-rw-r--r--    1 pab      staff      10322 Dec 20 16:19
Vl__CalibObject_8H-source.html
-rw-r--r--    1 pab      staff      12189 Dec 20 16:19
Vl__CalibPlane_8H-source.html
-rw-r--r--    1 pab      staff       4164 Dec 20 16:19
Vl__PatternGuideData_8H-source.html
-rw-r--r--    1 pab      staff       6776 Dec 20 16:19
Vl__PatternImageData_8H-source.html
-rw-r--r--    1 pab      staff       7327 Dec 20 16:19
Vl__PatternWorld2dData_8H-source.html
-rw-r--r--    1 pab      staff      11480 Dec 20 16:19
Vl__PatternWorld3dData_8H-source.html
-rw-r--r--    1 pab      staff       3599 Dec 20 16:19
Vl__PatternWorldData_8H-source.html
-rw-r--r--    1 pab      staff       2100 Dec 20 16:19
annotated.html
-rw-r--r--    1 pab      staff       4146 Dec 20 16:19
classVl__CalibObjectGuideData-members.html
-rw-r--r--    1 pab      staff       3534 Dec 20 16:19
classVl__CalibObjectGuideData.html
-rw-r--r--    1 pab      staff       4433 Dec 20 16:19
classVl__CalibObjectImageData-members.html
-rw-r--r--    1 pab      staff       3521 Dec 20 16:19
classVl__CalibObjectImageData.html
-rw-r--r--    1 pab      staff       3364 Dec 20 16:19
classVl__CalibObjectWorldData-members.html
-rw-r--r--    1 pab      staff       4723 Dec 20 16:19
classVl__CalibObjectWorldData.html
-rw-r--r--    1 pab      staff       3692 Dec 20 16:19
classVl__PatternGuideData-members.html
-rw-r--r--    1 pab      staff       3024 Dec 20 16:19
classVl__PatternGuideData.html
-rw-r--r--    1 pab      staff       6106 Dec 20 16:19
classVl__PatternImageData-members.html
-rw-r--r--    1 pab      staff       4487 Dec 20 16:19
classVl__PatternImageData.html
-rw-r--r--    1 pab      staff       7496 Dec 20 16:19
classVl__PatternWorld2dData-members.html
-rw-r--r--    1 pab      staff       6405 Dec 20 16:19
classVl__PatternWorld2dData.html
-rw-r--r--    1 pab      staff       2095 Dec 20 16:19
classVl__PatternWorld2dData__coll__graph.gif
-rw-r--r--    1 pab      staff       2095 Dec 20 16:19
classVl__PatternWorld2dData__inherit__graph.gif
-rw-r--r--    1 pab      staff      13622 Dec 20 16:19
classVl__PatternWorld3dData-members.html
-rw-r--r--    1 pab      staff       9515 Dec 20 16:19
classVl__PatternWorld3dData.html
-rw-r--r--    1 pab      staff       2098 Dec 20 16:19
classVl__PatternWorld3dData__coll__graph.gif
-rw-r--r--    1 pab      staff       2098 Dec 20 16:19
classVl__PatternWorld3dData__inherit__graph.gif
-rw-r--r--    1 pab      staff       3708 Dec 20 16:19
classVl__PatternWorldData-members.html
-rw-r--r--    1 pab      staff       3976 Dec 20 16:19
classVl__PatternWorldData.html
-rw-r--r--    1 pab      staff       3663 Dec 20 16:19
classVl__PatternWorldData__inherit__graph.gif
-rw-r--r--    1 pab      staff       1180 Dec 20 16:19
doxygen.css
-rw-r--r--    1 pab      staff       2378 Dec 20 16:19
doxygen.gif
-rw-r--r--    1 pab      staff       2401 Dec 20 16:19
files.html
-rw-r--r--    1 pab      staff       1500 Dec 20 16:19
functions.html
-rw-r--r--    1 pab      staff       2015 Dec 20 16:19
graph_legend.dot
-rw-r--r--    1 pab      staff      11788 Dec 20 16:19
graph_legend.gif
-rw-r--r--    1 pab      staff       4392 Dec 20 16:19
graph_legend.html
-rw-r--r--    1 pab      staff       1882 Dec 20 16:19
hierarchy.html
-rw-r--r--    1 pab      staff        989 Dec 20 16:19
index.html
-rw-r--r--    1 pab      staff        645 Dec 20 16:19
inherit__graph__0.gif
-rw-r--r--    1 pab      staff        920 Dec 20 16:19
inherit__graph__1.gif
-rw-r--r--    1 pab      staff        932 Dec 20 16:19
inherit__graph__2.gif
-rw-r--r--    1 pab      staff        936 Dec 20 16:19
inherit__graph__3.gif
-rw-r--r--    1 pab      staff        611 Dec 20 16:19
inherit__graph__4.gif
-rw-r--r--    1 pab      staff        780 Dec 20 16:19
inherit__graph__5.gif
-rw-r--r--    1 pab      staff        785 Dec 20 16:19
inherit__graph__6.gif
-rw-r--r--    1 pab      staff       3024 Dec 20 16:19
inherit__graph__7.gif
-rw-r--r--    1 pab      staff       2993 Dec 20 16:19
inherits.html
[claymore.82]% 

__________________________________________________
Do You Yahoo!?
Check out Yahoo! Shopping and Yahoo! Auctions for all of
your unique holiday gifts! Buy at http://shopping.yahoo.com
or bid at http://auctions.yahoo.com

[Doxygen-users] include graph

[Paul B. <pee...@ya...>]

I am a new user of Doxygen.

I am trying to create a graph showing include 
dependencies but I am not seeing any graph
in the generated documentation.  I have set all the
required tags as listed in

# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES,
INCLUDE_GRAPH, and HAVE_DOT 
# tags are set to YES then doxygen will generate a
graph for each documented 
# file showing the direct and indirect include
dependencies of the file with 
# other documented files.

and I am also using 'dot'.

I am running doxygen in a single directory which
contains a number of C++ classes, and at least
one .H file includes another .H file in the same 
directory (that's apart from included .H files
from outside that directory).  So I figure I should
be seeing at least the include of the local .H,
shown as a graph.

Can anyone help, or point me to an example of how to 
create an include dependency graph?

Thanks,
Paul.


__________________________________________________
Do You Yahoo!?
Check out Yahoo! Shopping and Yahoo! Auctions for all of
your unique holiday gifts! Buy at http://shopping.yahoo.com
or bid at http://auctions.yahoo.com

[Doxygen-users] (no subject)

[Judith K. <Jud...@re...>]

I have just started using doxygen and am having troubles setting up
the configuration file.
I am editing a file which has already been commented, to give examples of 4
specific types of comment.  I currently only get the output of the last
comment which I add to the .h file, although each one works fine
individually.
I also get output from all other comments, which I do not need.

Please can you help?!

Judith

Re: [Doxygen-users] gifs alignment in HTML

[Christopher B. <bre...@ya...>]

You need to make the graphic file at the correct size
before you give it to Doxygen. If it's object-oriented
(Draw-type as opposed to Paint-type, such as Visio),
just enlarge the scale. You might also be able to
control the baseline by cropping within the original
graphic.

Christopher Brewster

--- Jean-Max Redonnet
<jma...@me...> wrote:
> Hello, 
> 
> I'm a new user of Doxygen, and I would first send my
> greatings to people 
> working onto this wonderful soft.
> 
> I just have a small cosmetic problem :
> When generating gifs into HTML doc, these images
> appear too small and too 
> high relativly to baseline. I've not found any info
> in relation to this 
> problem anywhere in Doxygen documentation nor
> mailing-list archives.
> 
> How can I do to work around this problem.
> 
> Thanks for any help.
> 
> jmr


__________________________________________________
Do You Yahoo!?
Check out Yahoo! Shopping and Yahoo! Auctions for all of
your unique holiday gifts! Buy at http://shopping.yahoo.com
or bid at http://auctions.yahoo.com

Re: [Doxygen-users] Complicated aliases

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

On Tue, Dec 18, 2001 at 05:05:03AM -0800, Matt Wolf wrote:
> I was actually trying to alleviate the need for the developer to add an 
> end block.  I was wondering if there was a clever way to have the 
> original alias [ "sample= @par Sample Usage: \n @code" ] insert the 
> @endcode after it encountered a blank line or other section command.  
> If this is not possible, then that's OK.  

No this is not possible at the moment. I have been thinking about this, but
haven't taken the time to implement user-defined commands with arguments.

Regards,
  Dimitri

[Doxygen-users] Order of documentation in latex output?

[Chris N. <cn...@zo...>]

Hi,

I've started using doxygen, and noticed that is a great program, not
only for documentation of the source, but also parts of the design.

I find it very convenient to describe the workings of the software on a
somewhat higher layer than methods and functions, and it's very pleasant
that this "design-like docs" can refer to classes and methods, which
appear as links in the HTML.

Unfortunately, when I create latex output, this information appears
after all the details of each method, and I'd like to put them before.

The mainpage appears at the front (which I want), but I'd like to
change the order in the latex output. Is that possible?

Greetings,
Chris Niekel


--=20
Geek code version 3.1:
GCS d- s++: a- C++$ ULSI++ P+(---) L+++>++++ E--- W++ N++ o K? w--- O M-=20
V?>-- PS+ PE-() Y PGP+ t+>+++ 5? X- !R tv+ b DI++ D+ G>++ e+++ h--- r+++ y+=
+++

RE: [Doxygen-users] Complicated aliases

[Matt W. <Mat...@sp...>]

I was actually trying to alleviate the need for the developer to add an =
end block.  I was wondering if there was a clever way to have the =
original alias [ "sample=3D @par Sample Usage: \n @code" ] insert the =
@endcode after it encountered a blank line or other section command.  If =
this is not possible, then that's OK. =20

-----Original Message-----
From: Heine, Matthew [mailto:mh...@ha...]
Sent: Monday, December 17, 2001 3:18 PM
To: dox...@li...
Subject: RE: [Doxygen-users] Complicated aliases


Sure. A "endsample =3D @endcode" would get you a matching block.

-----Original Message-----
From: Matt Wolf [mailto:Mat...@sp...]
Sent: Monday, December 17, 2001 1:51 PM
To: dox...@li...
Subject: [Doxygen-users] Complicated aliases



I would like to add an alias called sample which essentially looks like =
"sample=3D @par Sample Usage: \n @code".  The premise is that a =
developer could add some sample code depicting the usage.  =
Unfortunately, this doesn't end the code block (i.e. I still need to add =
a @endcode).  This alias will work for examples in which the comment =
block terminates; however, doxygen gives the error "Error: comment block =
ended inside \code ... \endcode block ..."  Is there a correct method =
for doing this?

Matthew E. Wolf=20
[ Applications Engineer, Government Wireless ]=20
Spectrum Signal Processing, Inc.=20

t 301.459.8888 x18 // f  301.459.8887=20

< http://www.spectrumsignal.com>=20

Confidential information may be contained in this message.=20
If you are not the addressee indicated in this message please=20
destroy this message and kindly notify the sender by reply email.=20

[Doxygen-users] gifs alignment in HTML

[Jean-Max R. <jma...@me...>]

Hello,=20

I'm a new user of Doxygen, and I would first send my greatings to people=20
working onto this wonderful soft.

I just have a small cosmetic problem :
When generating gifs into HTML doc, these images appear too small and too=
=20
high relativly to baseline. I've not found any info in relation to this=20
problem anywhere in Doxygen documentation nor mailing-list archives.

How can I do to work around this problem.

Thanks for any help.

jmr

--=20
_________________________________________________________________________=
_____
Jean-Max Redonnet                        mailto:redonnetNOSP@Mlgmt.ups-tl=
se.fr
please replace NOSP@M with @ for reply
remplacez NOSP@M par @ pour r=E9pondre

[Doxygen-users] RE: search engine

[<ric...@gr...>]

I would like to point out an (obvious?) alternative way to create
search engine. Simply use htdig <http://www.htdig.org> by specifying
following in the Doxygen config file:

SEARCHENGINE            = YES
CGI_NAME                = htsearch
CGI_URL                 = http://localhost/cgi-bin
DOC_URL                 = http://localhost

"htsearch" is the CGI executable that comes with htdig.

After using htdig for a few days, I found it very very useful.
I highly recommend it.

I was not able to use "doxytag -s search.idx" because it is such a
memory hog that it would have taken many hours on my Linux box with
512Mbyte of RAM due to constant paging.
I know that doxytag takes about 15 minutes on directory with about
30MBytes of HTML files.  However, 200MBytes of HTML is too much for
doxytag to handle.

RE: [Doxygen-users] Using doxygen with large projects

[Glenn M. <gle...@vo...>]

Hi Ray,

You already have the solution. Break your system up into smaller pieces.
Have separate doxygen project files for the various subsystems. They
each can output to their own directories. The advantage of this is that
each subset will run faster. If something changes, you won't necessarily
have to regenerate the world.

For dependencies between systems, you need to generate tag files and
include them where appropriate in other project files. These are two
options that are documented (tersely) in the default Doxygen project
file.

Note: If two sub-systems depend upon each other, you may have to run
Doxygen twice so that it can resolve things using the tag files.

I successfully use this technique and it works like a charm.

I admit, however, that I wrote some homegrown Perl tools to wrap the
multiple outputs from Doxygen (and HTML output from various FrameMaker
books) into a comprehensive help system. For information available upon
request.=20

HTH,

Glenn Maxey
Technical Writer
Voyant Technologies, Inc.
1765 West 121st Avenue
Westminster, CO 80234-2301
Tel. +1 303.223.5164
Fax. +1 303.223.5275
gle...@vo...


> -----Original Message-----
> From: Ray F. Cowan [mailto:rf...@SL...]
> Sent: Monday, December 17, 2001 1:56 PM
> To: dox...@li...
> Cc: Stephen Gowdy; Ruth Schmitz
> Subject: [Doxygen-users] Using doxygen with large projects
>=20
>=20
> Hi,
>=20
> I am attempting to use doxygen to produce docs for a rather large C++
> project, about 1000 packages containing in total some 20,000=20
> individual
> {.cc,.hh} files.  This is the bulk of the software used by=20
> the international
> high-energy physics experiment, BaBar=20
> (www-public.slac.stanford.edu/babar).
>=20
> However, attempts to run doxygen fail when running on our=20
> complete code base;
> on a linux box doxygen runs for four hours or so in the=20
> 'Reading input files'
> stage, reaches around 900 MB of memory use, then aborts.
>=20
> Doxygen runs fine on small subsets of our code,
> so I think our problem is due to the large amount of source=20
> code when running all of it together.
>=20
> Another problem--assuming we can get doxygen to run on our=20
> code--is that all
> the output html files are placed in a single directory. =20
=20
> Any suggestions for solving these problems would be=20
> appreciated.  Thanks much.
>=20

[Doxygen-users] Using doxygen with large projects

[Ray F. C. <rf...@SL...>]

Hi,

I am attempting to use doxygen to produce docs for a rather large C++
project, about 1000 packages containing in total some 20,000 individual
{.cc,.hh} files.  This is the bulk of the software used by the international
high-energy physics experiment, BaBar (www-public.slac.stanford.edu/babar).

However, attempts to run doxygen fail when running on our complete code base;
on a linux box doxygen runs for four hours or so in the 'Reading input files'
stage, reaches around 900 MB of memory use, then aborts.

The Doxyfile has been configured for html output only.  No html is produced
in the output directory.

I'm a novice at running doxygen, so perhaps someone has some suggestions on
how to handle large projects?  Doxygen runs fine on small subsets of our code,
so I think our problem is due to the large amount of source code when running
all of it together.

Another problem--assuming we can get doxygen to run on our code--is that all
the output html files are placed in a single directory.  Since each source
file produces several .html files, the output from our 20,000 files will
approach 50,000 files or more...and our afs file system can only handle
about 31,000 files per directory.  It would be extremely nice if doxygen
maintained the package structure of the input files in the output directory.
Anyone know how to do this?  Or a reasonable workaround?

Any suggestions for solving these problems would be appreciated.  Thanks much.

--Ray Cowan
  BaBar Collaboration docmaster

RE: [Doxygen-users] Complicated aliases

[Heine, M. <mh...@ha...>]

Sure. A "endsample = @endcode" would get you a matching block.

-----Original Message-----
From: Matt Wolf [mailto:Mat...@sp...]
Sent: Monday, December 17, 2001 1:51 PM
To: dox...@li...
Subject: [Doxygen-users] Complicated aliases



I would like to add an alias called sample which essentially looks like "sample=
@par Sample Usage: \n @code".  The premise is that a developer could add some
sample code depicting the usage.  Unfortunately, this doesn't end the code block
(i.e. I still need to add a @endcode).  This alias will work for examples in
which the comment block terminates; however, doxygen gives the error "Error:
comment block ended inside \code ... \endcode block ..."  Is there a correct
method for doing this?

Matthew E. Wolf 
[ Applications Engineer, Government Wireless ] 
Spectrum Signal Processing, Inc. 

t 301.459.8888 x18 // f  301.459.8887 

< http://www.spectrumsignal.com <http://www.spectrumsignal.com> > 

Confidential information may be contained in this message. 
If you are not the addressee indicated in this message please 
destroy this message and kindly notify the sender by reply email. 

[Doxygen-users] Complicated aliases

[Matt W. <Mat...@sp...>]

I would like to add an alias called sample which essentially looks like =
"sample=3D @par Sample Usage: \n @code".  The premise is that a =
developer could add some sample code depicting the usage.  =
Unfortunately, this doesn't end the code block (i.e. I still need to add =
a @endcode).  This alias will work for examples in which the comment =
block terminates; however, doxygen gives the error "Error: comment block =
ended inside \code ... \endcode block ..."  Is there a correct method =
for doing this?

Matthew E. Wolf=20
[ Applications Engineer, Government Wireless ]
Spectrum Signal Processing, Inc.

t 301.459.8888 x18 // f  301.459.8887

<http://www.spectrumsignal.com>

> Confidential information may be contained in this message.=20
> If you are not the addressee indicated in this message please=20
> destroy this message and kindly notify the sender by reply email.
>=20

RE: [Doxygen-users] Search engines

[Glenn M. <gle...@vo...>]

Hi Moshe,
=20
I purchased DevaSearch for $99 ( http://www.devahelp.com/). I didn't
need the full blown suite of tools for Dreamweaver.
=20
DevaSearch is not dynamic in that you run it on a set of files and it
remains static until you run it again. However, it is great for my uses:
delivery on CD-ROM and over the intranet.
=20
I don't use the Search that's built into Doxygen. I like the DevaSearch
because I can specify what gets included. My projects have multiple
Doxygen builds and several directories with the HTML output from
FM/Mif2Go.
=20
More important than the Search, I implemented a tool in Perl to create
an index over my set of HTML files. The HTML output from Doxygen is
consistent enough -- particularly with the doxytag references -- where I
can reliably find appropriate anchors to include in the index. I also do
what I call "word-chunking" whereby a code item like "getMosheMovieList"
would have the following index items:
=20
getMosheMovieList
list
   getMosheMovieList
moshe
   getMosheMovieList
movie
   getMosheMovieList
=20
Yes, it does "bloat" the index, but it's online. My index has static
pages [a-z], so they load fast and can be scrolled quickly up and down.
Online users don't complain about too many index entries. (One system I
produce has 16,000.)
=20
The index is actually more useful than the full-text search in the long
run. When dealing with code items, I think that my index is better. With
my homegrown tool, the developer doesn't have to know the exact name of
the code item. If they know that "movie" or "list" is part of the code
item name, they can get there. IME I believe that the FTS provides more
outright misses than hits.
=20
Here's something from Jared Spool ( jar...@ui...) of User
Interface Engineering about search engines and websites:
=20
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--> Users Don't Learn to Search Better

When we watched 30 users trying to search various sites for content they
were interested in, we noticed a peculiar phenomenon:

The more times the users searched, the less likely they were to find
what they wanted.

The data is quite clear on this: On a single search, users found their
content 55% of the time, whereas users who searched twice found their
content only 38% of the time. None of the users in our study who
searched more than twice ever found their target content.

As we mentioned in the last UIEtips, less than 25% of our users searched
more than two times. But those that did persevere did not see positive
results.

The #1 cause of people trying to search more than once is getting a "no
results" message in response to their query. Most users give up when
this happens. However, some try their query a second time.

Here's what happened in our study:

On the first search attempt, 23% of the users got a "no results"
message.

Of those users who kept going, 44% got a "no results" on the second
attempt.

If they still persisted, 50% got a "no results" on the third attempt.

And if they were really persistent, it didn't help because 100% got a
"no results" on the fourth attempt.

Theoretically, as people use the search engine, they should get better
at making it perform. After all, each successive interaction is a
learning moment -- something that is teaching them the idiosyncrasies of
the tool.

But that's not what we've seen. Either users succeed up front, or things
go downhill rapidly.

Encouraging users to continue with helpful hints doesn't actually seem
to help. As we mentioned before, many sites provide hints on the "no
results" pages that try to encourage users to enter different search
terms. Unfortunately, the presence of these hints didn't reduce the odds
that a user would get a "no results" the next time around.

Keep in mind that the way we constructed the study is very telling: We
specifically brought the users to sites that had the content they were
seeking. The fact that one out of every 5 users got a "no results"
message on their first attempt says that there is something
fundamentally wrong here.

The key for designers seems to lie in getting users relevant results on
the first try. The sites that did that were most likely to succeed.

(Erik Ojakaar is in the process of compiling the results of this study
into a nifty, new report on Search. If you found this article
interesting, you'll find the report invaluable. We'll let you know as
soon as it's ready!)

- o - o - o -

=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
=20
In other UIEtips, they prove through usability testing that designed
content navigation is more effective than Search at getting the user's
where they need to go.
=20
HTH,
Glenn Maxey
Technical Writer
Voyant Technologies, Inc.
1765 West 121st Avenue
Westminster, CO 80234-2301
Tel. +1 303.223.5164
Fax. +1 303.223.5275
gle...@vo...


=20
=20
 -----Original Message-----
From: Moshe Kruger [mailto:Kr...@Pa...]
Sent: Sunday, December 16, 2001 8:36 AM
To: 'Dox...@li...'
Subject: [Doxygen-users] Search engines



Dear listers,
=20
The native search engine provided with Doxygen requires the installation
of HTTP daemon.
=20
Based on past experience, our developers have rejected this setup as it
makes life particularly difficult for customers configuring applications
requiring an HTTP daemon.
=20
Can you make any other well-informed recommendations? Open Software (if
it's as good as Doxygen :-)) or shareware would be preferable, of
course, but are not an absolute requirement.
=20
TIA,
=20
Moshe Kruger
Technical Communicator
Paradigm Geophysical

Re: [Doxygen-users] Patch for showing inherited members in a derived class

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

On Fri, Dec 14, 2001 at 10:23:27AM +0100, Cyrille Chépélov wrote:
> Ted,
> 
> I've applied this patch to the Debian 1.2.11.1 package (both hunks apply
> with only a slight offset). This works great !
> 
> In fact, it would be absolutely perfect, if it showed (perhaps optionally)
> an [inherited] tag next to the function declarator (or [inherited,inline] in
> the case of inlines), but even in this state, I strongly vote for the
> inclusion.
> 
> (yes, I know that it is possible to see that a member has been inherited,
> since they're shown fully qualified. Making things explicit wouldn't be a
> bad thing, though).
> 
> Dimitry, any comments ?

I like the idea as well, but the current patch (thanks Ted)
still has problems w.r.t. html labels, protection levels, and external 
references. I'm working on a more solid implementation at the moment.

Regards,
  Dimitri

[Doxygen-users] Search engines

[Moshe K. <Kr...@Pa...>]

Dear listers,
 
The native search engine provided with Doxygen requires the installation of
HTTP daemon.
 
Based on past experience, our developers have rejected this setup as it
makes life particularly difficult for customers configuring applications
requiring an HTTP daemon.
 
Can you make any other well-informed recommendations? Open Software (if it's
as good as Doxygen :-)) or shareware would be preferable, of course, but are
not an absolute requirement.
 
TIA,
 
Moshe Kruger
Technical Communicator
Paradigm Geophysical

Re: [Doxygen-users] doxygen and graphviz

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

On Fri, Dec 14, 2001 at 02:25:45PM -0600, Rod Ollerhead wrote:
> Doxygen does not create graphs for the interaction between functions ( too bad
> because that would be so intuitive to look at - huge, but intuitive ).  The
> graphing is used to represent the interaction between classes - inheritance.
> 
> However, it does do something nearly as awesome that will likely assist you.
> Individual parsed source files are available in the documentation, and here's
> the big plus, it's hyperlinked.  Just click a function call and you'll jump to
> the function -whether it's in the same class or not.
> 
> . . . so, yes,  you can see the interaction between different functions
> scattered in diff. files, not as a graph, but as html documentation.

Yes, and this info is also present in the XML output, so if you know how
to parse XML (scripting languages such as perl and python can do this 
conveniently) you can easily generate such a graph using dot. I have plans 
to write such a tool as an example of using the XML output, but also have 
enough other things to do, so if anyone wants to do this, please let me know.

Regards,
  Dimitri

> Marian Gutica wrote:
> 
> > Hi,
> > I am new to doxygen. I want to reverse engineer a application written in C.
> > I am able to generate html files but what I am looking for are the
> > interaction graphs  between different functions scattered in different
> > files, who calls who. First of all is this possible ? If it is what
> > configuration variables I have to use ? Do I have to add any doxygen
> > keywords in my source files ?
> > Second only when I use EXTRACT_ALL=YES I get the include dependency graph,
> > but just the .gif files not the .dot files. Is this because I have set
> > DOT_CLEANUP=YES ? I gathered probably this is the reason and I can test it
> > anyway.
> >

[Doxygen-users] PROJECT_NUMBER Configuration Option

[Angela M. <ang...@ca...>]

In the configuration file, I have set the PROJECT_NUMBER option to the
revision number, but can see no evidence of it in the generated
documentation.

I am interested in using this option with CVS to have separate versions of
the documentation availabe.  The Doxygen webpage seems to indicate this is
possible, since it says: "The PROJECT_NUMBER tag can be used to enter a
project or revision number. This could be handy for archiving the generated
documentation or if some version control system is used. " Where does this
option come into play?

Thanks for your help,
Angela

Re: [Doxygen-users] doxygen and graphviz

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

Doxygen does not create graphs for the interaction between functions ( too bad
because that would be so intuitive to look at - huge, but intuitive ).  The
graphing is used to represent the interaction between classes - inheritance.

However, it does do something nearly as awesome that will likely assist you.
Individual parsed source files are available in the documentation, and here's
the big plus, it's hyperlinked.  Just click a function call and you'll jump to
the function -whether it's in the same class or not.

. . . so, yes,  you can see the interaction between different functions
scattered in diff. files, not as a graph, but as html documentation.

Merry Christmas,
Rod

Marian Gutica wrote:

> Hi,
> I am new to doxygen. I want to reverse engineer a application written in C.
> I am able to generate html files but what I am looking for are the
> interaction graphs  between different functions scattered in different
> files, who calls who. First of all is this possible ? If it is what
> configuration variables I have to use ? Do I have to add any doxygen
> keywords in my source files ?
> Second only when I use EXTRACT_ALL=YES I get the include dependency graph,
> but just the .gif files not the .dot files. Is this because I have set
> DOT_CLEANUP=YES ? I gathered probably this is the reason and I can test it
> anyway.
>
> I will appreciate help mainly for the first question.
>
> Thanks,
> ----------------------------------------------------------
> Marian Gutica
> SW Support Manager
> Direct: (604)214-7265
> Tel: (604)241-1441
> Fax: (604)241-1440
> E-mail: mar...@di...
> ----------------------------------------------------------
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Title from \page tag not always shown

[Christopher B. <bre...@ya...>]

I use the following tag:

   \page page_label Title of This Page

I have gotten inconsistent behavior: the title shown
after the page label sometimes appears on the page as
a title (approximately <H2> level) but sometimes gets
dropped. It always shows in the "Related Pages" node
of the navigation bar. I'd like to know if anyone else
has seen this happen.

Christopher Brewster

__________________________________________________
Do You Yahoo!?
Check out Yahoo! Shopping and Yahoo! Auctions for all of
your unique holiday gifts! Buy at http://shopping.yahoo.com
or bid at http://auctions.yahoo.com

Re: [Doxygen-users] Patch for showing inherited members in a derived class

[<cy...@so...>]

Ted,

I've applied this patch to the Debian 1.2.11.1 package (both hunks apply
with only a slight offset). This works great !

In fact, it would be absolutely perfect, if it showed (perhaps optionally)
an [inherited] tag next to the function declarator (or [inherited,inline] in
the case of inlines), but even in this state, I strongly vote for the
inclusion.

(yes, I know that it is possible to see that a member has been inherited,
since they're shown fully qualified. Making things explicit wouldn't be a
bad thing, though).

Dimitry, any comments ?

    -- Cyrille

[Doxygen-users] doxygen and graphviz

[Marian G. <Mar...@di...>]

Hi,
I am new to doxygen. I want to reverse engineer a application written in C.
I am able to generate html files but what I am looking for are the
interaction graphs  between different functions scattered in different
files, who calls who. First of all is this possible ? If it is what
configuration variables I have to use ? Do I have to add any doxygen
keywords in my source files ?
Second only when I use EXTRACT_ALL=YES I get the include dependency graph,
but just the .gif files not the .dot files. Is this because I have set
DOT_CLEANUP=YES ? I gathered probably this is the reason and I can test it
anyway.

I will appreciate help mainly for the first question.

Thanks,
----------------------------------------------------------
Marian Gutica
SW Support Manager
Direct: (604)214-7265
Tel: (604)241-1441
Fax: (604)241-1440
E-mail: mar...@di...
----------------------------------------------------------