doxygen-users — List for users of doxygen

[Doxygen-users] Problem with tag files.

[Markus <mar...@gi...>]

Hi there,

I have a problem using a tag file for references.

The tag file looks somthing like this:

<?xml version='1.0' encoding='ISO-8859-1' standalone='yes'?>
<tagfile>
  <compound kind="struct">
    <name>WIN32_FIND_DATA</name>
    <filename>mk:@MSITStore:\\FILESERVER\MSDN_CD_COPY\MSDN_L~3\MSDN\fileio.chm::/hh/winbase/filesio_4xv6.htm</filename>
  </compound>
</tagfile>

Doxygen reads the file without any problem but when generating a reference to the struct it appends an extra ".html" to the filename. :-( Anyone know how I can change this behaviour?

TIA, Markus

[Doxygen-users] Documenting file members....

[Johan E. <joh...@ua...>]

Hi,
    I thought it was necessary to explict document the file members 
using   a structural command even if the corresponding C++ entity is 
declared immediatelly after the documentation block. For example, in 
header file foo.h:

/** \file
   * Some desc of file foo.h.....
   */

/** \enum AnEnum
   * Some desc...
   */
enum AnEnum
{
    Value0,
    Value1
};

However, in version 1.2.14 this seems not to be necessary anymore. It is 
just to do:

/** \file
   * Some desc of file foo.h.....
   */

/**
   * Some desc...
   */
enum AnEnum
{
    Value0,
    Value1
};

Is this right or is it a bug??? Personally I like the latter better, 
less to type and it is more consistent when documenting compound members.

Thanks,
        Johan

RE: [Doxygen-users] Methods on COM objects

[Martin B. <MBo...@op...>]

Dekuji pjekne

to opravdu fungovalo velice dobre.

I plugged it in and the thing worked stright away. I know that i should have
had checked the documentation more intensely, however i wasn't shure where
to look and was runnign out of time. I have tried to search for "COM" since
it was a COM project that has coused this. Also when reading the
documentation i found:

"The PREDEFINED tag can be used to specify one or more macro names"

This is confusing since i read this to mean that you are only defining
"macro names" but really you are defining macros.

Perhaps the documentation could be updated link COM to PREDEFINED as an
example?


Hi Martin,

You should focus on the "Preprocessing" part of the doxygen
documentation.  Inside, you can find the example of what should 
be added to the PREDEFINED in your Doxyfile (configuration
file).  You may want something more to get the wanted result.
Here is what I use in our project:

PREDEFINED             = WIN32, \
                         _WIN32, \
                         _x86, \
                         x86, \
                         _X86, \
                         X86, \
                         __cplusplus, \
                         _inline=inline, \
                         __inline=inline \
                         __stdcall= \
                         _stdcall= \
                         _export= \
                         __export= \
                         __import= \
                         _import= \
                         "__declspec(a)= " \
                         "STDMETHOD(x)=virtual HRESULT x" \
                         "STDMETHODIMP=HRESULT " \
                         "STDMETHODIMP_(type)=type " \
                         "STDMETHOD_(type,method)=virtual type method" \
                         "PURE= = 0" \
                         ATL_NO_VTABLE= \
                         BEGIN_CONNECTION_POINT_MAP=/* \
                         END_CONNECTION_POINT_MAP=*/// \
                         DECLARE_REGISTRY_RESOURCEID=// \
                         DECLARE_PROTECT_FINAL_CONSTRUCT=// \
                         DECLARE_VIEW_STATUS=// \
                         DECLARE_WND_CLASS_EX(x,y,z)=// \
                         BEGIN_COM_MAP=/* \
                         END_COM_MAP=*/// \
                         BEGIN_PROP_MAP=/* \
                         END_PROP_MAP=*/// \
                         BEGIN_MSG_MAP=/* \
                         END_MSG_MAP=*/// \
                         "DECLARE_INTERFACE(name)=class name" \
                         "DECLARE_INTERFACE_(name,base)=class name : public
base"

See you, 
   Petr
-- 
Petr Prikryl, Skil, spol. s r.o., (pri...@sk...)

> -----Original Message-----
> From:	Martin Bosticky [SMTP:MBo...@op...]
> Sent:	Tuesday, March 19, 2002 1:26 AM
> To:	doxygen user list
> Subject:	[Doxygen-users] Methods on COM objects
> 
> Hi Everyone.
>  
> I have searched the documentation and i couldn't figure out how to
> document COM methods.
>  
> I tried to create documentation for a COM object. I have an interface
> called IScheduleSetProcessor and a correcponding class called
> CScheduleSetProcessor. On this class there is a COM method defined as:
>  
> public:
>  STDMETHOD(Initialise)(/*[in]*/ BSTR strAuthentication, /*[in]*/
> IDataServer* pDataServer, /*[in]*/ IScheduleSet* pScheduleSet);
> 
> and the implementation of the method is
>  
> STDMETHODIMP CScheduleSetProcessor::Initialise(BSTR strAuthentication,
> IDataServer* pDataServer, IScheduleSet* pScheduleSet)
> {
> ...
> }
>  
> So i think, ok, this will require macro expansion right? So i tried that
> and tried to include the BASETYPS.H file with the appropriate expansion
> macros etc, and all i could get was:
>  
>  	 STDMETHOD
> <file:///D:/OPCrew/Src/ScheduleSetServer/html/classCScheduleSetProcessor.h
> tml#a3> (Initialise)(BSTR strAuthentication	
>  
> in the html documentation output. This happends even if i swith it off. 
>  
> Thus 1. it seems i don't know how to switch on the macro expansion
> properly and 2. something wrong is happening in the output. 
>  
> Any suggestions?
>  
> Has anyone else tried to do this?
>  
> Thanks, Martin.

[Doxygen-users] Dot diagrams very small

[<po...@rn...>]

Hi all,

I've installed doxygen and I'm updating my C project to support
special comments to document the source.
I've installed the dot file (it came in a package mentioned
somewhere, I can't remember now... anyway, I have it installed).
The diagram is generated and it appears in the dvi file very,
very small...
In the html the diagram is with the correct size but the letters
are out of the boxes... :-(

Any ideas?

Best regards,

-- 
Paulo J. Matos : pocm(_at_)rnl.ist.utl.pt
Instituto Superior Tecnico - Lisbon    
Software & Computer Engineering - A.I.
 - > http://www.rnl.ist.utl.pt/~pocm 
 ---	
	Yes, God had a deadline...
		So, He wrote it all in Lisp!

[Doxygen-users] Settings for EXCLUDE tag are discarded when running doxygen

[Dirk A. S. <dir...@im...>]

Hi,

I'm using the latest windows version (1.2.14) and doxygen doesn't 
exclude the files / directories specified in the EXCLUDE tag. This 
happens when using doxywizard as well as for the command line use. For a 
few files I could just add them to the EXCLUDE_PATTERN tag but for large 
subdirectory structures this is not really a solution.

I would be greatful for some help.

Thanks. Dirk-Alexander

RE: [Doxygen-users] Methods on COM objects

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

Hi Martin,

You should focus on the "Preprocessing" part of the doxygen
documentation.  Inside, you can find the example of what should 
be added to the PREDEFINED in your Doxyfile (configuration
file).  You may want something more to get the wanted result.
Here is what I use in our project:

PREDEFINED             = WIN32, \
                         _WIN32, \
                         _x86, \
                         x86, \
                         _X86, \
                         X86, \
                         __cplusplus, \
                         _inline=inline, \
                         __inline=inline \
                         __stdcall= \
                         _stdcall= \
                         _export= \
                         __export= \
                         __import= \
                         _import= \
                         "__declspec(a)= " \
                         "STDMETHOD(x)=virtual HRESULT x" \
                         "STDMETHODIMP=HRESULT " \
                         "STDMETHODIMP_(type)=type " \
                         "STDMETHOD_(type,method)=virtual type method" \
                         "PURE= = 0" \
                         ATL_NO_VTABLE= \
                         BEGIN_CONNECTION_POINT_MAP=/* \
                         END_CONNECTION_POINT_MAP=*/// \
                         DECLARE_REGISTRY_RESOURCEID=// \
                         DECLARE_PROTECT_FINAL_CONSTRUCT=// \
                         DECLARE_VIEW_STATUS=// \
                         DECLARE_WND_CLASS_EX(x,y,z)=// \
                         BEGIN_COM_MAP=/* \
                         END_COM_MAP=*/// \
                         BEGIN_PROP_MAP=/* \
                         END_PROP_MAP=*/// \
                         BEGIN_MSG_MAP=/* \
                         END_MSG_MAP=*/// \
                         "DECLARE_INTERFACE(name)=class name" \
                         "DECLARE_INTERFACE_(name,base)=class name : public
base"

See you, 
   Petr
-- 
Petr Prikryl, Skil, spol. s r.o., (pri...@sk...)

> -----Original Message-----
> From:	Martin Bosticky [SMTP:MBo...@op...]
> Sent:	Tuesday, March 19, 2002 1:26 AM
> To:	doxygen user list
> Subject:	[Doxygen-users] Methods on COM objects
> 
> Hi Everyone.
>  
> I have searched the documentation and i couldn't figure out how to
> document COM methods.
>  
> I tried to create documentation for a COM object. I have an interface
> called IScheduleSetProcessor and a correcponding class called
> CScheduleSetProcessor. On this class there is a COM method defined as:
>  
> public:
>  STDMETHOD(Initialise)(/*[in]*/ BSTR strAuthentication, /*[in]*/
> IDataServer* pDataServer, /*[in]*/ IScheduleSet* pScheduleSet);
> 
> and the implementation of the method is
>  
> STDMETHODIMP CScheduleSetProcessor::Initialise(BSTR strAuthentication,
> IDataServer* pDataServer, IScheduleSet* pScheduleSet)
> {
> ...
> }
>  
> So i think, ok, this will require macro expansion right? So i tried that
> and tried to include the BASETYPS.H file with the appropriate expansion
> macros etc, and all i could get was:
>  
>  	 STDMETHOD
> <file:///D:/OPCrew/Src/ScheduleSetServer/html/classCScheduleSetProcessor.h
> tml#a3> (Initialise)(BSTR strAuthentication	
>  
> in the html documentation output. This happends even if i swith it off. 
>  
> Thus 1. it seems i don't know how to switch on the macro expansion
> properly and 2. something wrong is happening in the output. 
>  
> Any suggestions?
>  
> Has anyone else tried to do this?
>  
> Thanks, Martin.

[Doxygen-users] Methods on COM objects

[Martin B. <MBo...@op...>]

Hi Everyone.
 
I have searched the documentation and i couldn't figure out how to document
COM methods.
 
I tried to create documentation for a COM object. I have an interface called
IScheduleSetProcessor and a correcponding class called
CScheduleSetProcessor. On this class there is a COM method defined as:
 
public:
 STDMETHOD(Initialise)(/*[in]*/ BSTR strAuthentication, /*[in]*/
IDataServer* pDataServer, /*[in]*/ IScheduleSet* pScheduleSet);

and the implementation of the method is
 
STDMETHODIMP CScheduleSetProcessor::Initialise(BSTR strAuthentication,
IDataServer* pDataServer, IScheduleSet* pScheduleSet)
{
...
}
 
So i think, ok, this will require macro expansion right? So i tried that and
tried to include the BASETYPS.H file with the appropriate expansion macros
etc, and all i could get was:
 
 	 STDMETHOD
<file:///D:/OPCrew/Src/ScheduleSetServer/html/classCScheduleSetProcessor.htm
l#a3>  (Initialise)(BSTR strAuthentication	
 
in the html documentation output. This happends even if i swith it off. 
 
Thus 1. it seems i don't know how to switch on the macro expansion properly
and 2. something wrong is happening in the output. 
 
Any suggestions?
 
Has anyone else tried to do this?
 
Thanks, Martin.

[Doxygen-users] same routine commented in multiple places

[Jeff C. <dox...@mo...>]

Hello, everyone -

This is probably a newbie question, but I didn't see the answer in the 
docs. Is there a way to get Doxygen to merge markup on a function from 
multiple different files? What I would like to do is this:

in Foo.h:

class Foo {
   public:

     /**
      * Create a new Foo.
      *
      * @param ninjies  The number of ninjies to give this Foo.
      **/
     Foo (int ninjies);
}

in Foo.cc:

/**
  * @exception BadThingException if ninjies is zero.
  * @exception WorseThingException if ninjies is negative.
  **/
Foo::Foo (int ninjies)
{
   // ...
}

where the final documentation that Doxygen produces will merge the markup 
from the two files and present all of it as the documentation for Foo::Foo().

thanks,
Jeff

[Doxygen-users] How to use TABS ?

[Chris S. <chr...@bd...>]

Sorry if this is completely a stupid question, but i wonder how to use =
TABS in documenting my code ?

Thanks in advance,
Chris

[Doxygen-users] Doxygen-1.2.14-20020317 in CVS

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

Hi,

In this week's release the following has changed:
------------------------------------------------------------------------------
+ ADD: Included update for Romanian translation (thanks to Alex Iosup).
+ ADD: Added two new commands: LATEX_CMD_NAME and MAKEINDEX_CMD_NAME to
       set the name of the latex and makeindex tools to be used for latex
       output (thanks to Konno Akihisa for the patch).
+ BUG: In some cases the tree view showed leaf elements as non-leafs.
+ BUG: Fixed a number of cases where illegal characters could end up in
       the XML output.
+ BUG: If a function in a base class was (re)implemented by serveral classes
       only one of them appeared in the "(re)implemented in" list.
+ BUG: graph_legend.gif was hardcoded in translator_*.h files. 
       Note to translators: this has affected all translator files, so please
       update your local translator file with the one found in CVS!
+ BUG: In some cases a grouped member within a namespace did not appear
       in the group's documentation.
+ BUG: Namespace members were not properly cross-referenced with in the
       source browser output.
+ BUG: Using directives inside anonymous namespaces had no effect.
+ BUG: Fixed bug in the preprocessor when parsing '"' as the argument to
       a function macro. 
+ CHG: Doxygen now warns about undocumented compounds (thanks to Itai Frenkel
       for the patch).
------------------------------------------------------------------------------
Enjoy,
  Dimitri

RE: [Doxygen-users] Overriding configuration file settings on the command line

[Darren B. <db...@ga...>]

I have a similar issue.  I assume command-line overrides do not exist.

I plan on having a configuration file tree, using INCLUDE and INCLUDE_PATH
in the "leaf" files.  There will be one project-wide template, with
output-specific templates in a second layer, followed by lowest-level
templates.

Roughly, the output-specific templates will cover "external documentation
only, in latex/pdf" or "internal documentation, including source browser, in
html".

The lowest-level templates include INPUT, project name, and other
module-specific stuff.  There's duplication down here, since I need one low
level template for each output-specific template I want.  

Alternatively, you could use a makefile to concatenate standalone partial
templates into a single configuration file, and have different make targets
for different mix-and-match combinations.

Admittedly, both these mechanisms are not terribly flexible.  They assume in
advance the set of possible combinations.

--Darren Busing
         

-----Original Message-----
From: Patrick Hartling [mailto:pa...@vr...]
Sent: Friday, March 15, 2002 3:34 PM
To: dox...@li...
Subject: [Doxygen-users] Overriding configuration file settings on the
command line


Some time ago, I thought I saw that settings in a Doxygen configuration 
file could be overridden with command line options.  Today, I have been 
searching the Doxygen manual and the mailing lists, but I cannot find any 
information on how to do that.  Is it possible to use command line 
options to override configuration file settings?

The reason I want to do this is to change output options for different 
output formats.  For example, if I generate HTML, I would like source 
code to be included in the final HTML.  If, however, I generate LaTeX 
(and, ultimately, a PDF file), I do not want the source code included 
because it makes the document too long.  Maybe there is a better way to 
achieve these results that does not involve using command line options?

  -Patrick


-- 
Patrick L. Hartling                     | Research Assistant, VRAC
pa...@vr...                | 2624 Howe Hall -- (515)294-4916
http://www.137.org/patrick/             | http://www.vrac.iastate.edu/


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

[Doxygen-users] Overriding configuration file settings on the command line

[Patrick H. <pa...@vr...>]

Some time ago, I thought I saw that settings in a Doxygen configuration 
file could be overridden with command line options.  Today, I have been 
searching the Doxygen manual and the mailing lists, but I cannot find any 
information on how to do that.  Is it possible to use command line 
options to override configuration file settings?

The reason I want to do this is to change output options for different 
output formats.  For example, if I generate HTML, I would like source 
code to be included in the final HTML.  If, however, I generate LaTeX 
(and, ultimately, a PDF file), I do not want the source code included 
because it makes the document too long.  Maybe there is a better way to 
achieve these results that does not involve using command line options?

  -Patrick


-- 
Patrick L. Hartling                     | Research Assistant, VRAC
pa...@vr...                | 2624 Howe Hall -- (515)294-4916
http://www.137.org/patrick/             | http://www.vrac.iastate.edu/

[Doxygen-users] Re: Limited Support for VB

[Scot W. <sc...@wi...>]

> '
> '/*!
> '// \fn MyPatheticVBfunction(one AS integer)
> '//     yadda yadda description..
> '*/
> 
> Now this does not work because of the ' (single quote) 

A similar problem exists for shell scripts and other languages which use other 
comment markers.  A Doxygen command can be in a shell script after the 
script's '#' comment marker, but if the Doxygen command goes to a second line 
then the '#' is inserted in the Doxygen string.

I'm aware of six solutions:

1. Preprocess your files with programs which reformat for Doxygen.
2. Change Doxygen to configure the comment markers for each file or file suffix.
3. Change Doxygen to magically recognize umpteen file formats.
4. Change Doxygen so when it finds a Doxygen command it assumes the group of 
characters just ahead of the Doxygen command is the start-comment marker, and a 
group of symbol characters at the end of the line is the end-comment marker.  
Then ignore those strings until the end of the Doxygen command. (variation: 
limit this examination to the "@file" line then apply that rule to the file.)
5. Change Doxygen so when it recognizes a Doxygen command it remembers the C-
type comment marker ahead of the command, then ignores the start of following 
lines up to that same marker.
6. Change Doxygen to have a comment-definition command which is unique enough 
to be recognized in many file formats.  But this requires this command be in 
each file.  However, this command can work with the other techniques also.

Re: [Doxygen-users] Re: Using <PRE> with Doxygen (got a problem!)

[Greger H. <gre...@ya...>]

Asko Kauppi wrote:

Use sed to transform the comments to include both pre-tags, run it on each
file, after that adopt doxygens way of doing it, it's really nice i think.

something like:
sed s/\/\*/\*\!\<pre\>/g <in > out
sed s/\*\//\<\/pre\>\*\//g <in > out

/G

> Solving this by customized style sheets sounds like an elegant solution to
> me. However, I'd like such modifications to be one-time jobs, not needing
> any specialized "override" bat files. Can be flexible here, though... :)
>
> - Asko
>
> > -----Original Message-----
> > From: Zvi Mizrahi [SMTP:zv...@ga...]
> > Sent: 11. maaliskuuta 2002 14:41
> > To:   Asko Kauppi
> > Subject:      Re: [Fwd: [Doxygen-users] Using <PRE> with Doxygen   (got a
> > problem!)]
> >
> > Asko,
> > I think this can be easily fixed by editing the cascading style sheet file
> >
> > doxygen.css after Doxygen is running (in the html directory.
> > I have not tries it but ask the mailing list. Note that this file is
> > regenerated every running, so you need  to maintain a backup , and
> > override doxygen.css each time.
> >
> > Zvika
> >
> > Asko Kauppi wrote:
> >
> > Thanks for the support, Zvi! :)
> >
> > Also, the ability to have a fix-width font (as '<PRE>' does) is important
> > since the comments (at least ours) are indented using white space.
> >
> > Your idea of "do-it-yourself-filtering" crossed my mind but is too
> > elaborous
> > for me at the moment. After all, I'm just evaluating Doxygen and don't
> > want
> > to spend too much time filling up its holes.
> >
> > Let's see if the all-mighty authors are favorable for us on this. ;)
> >
> > - Asko
> >
> > > -----Original Message-----
> > > From: Zvi Mizrahi [SMTP:zv...@ga...]
> > > Sent: 11. maaliskuuta 2002 14:04
> > > To:   dox...@li...
> > > Cc:   Asko Kauppi
> > > Subject:      [Fwd: [Doxygen-users] Using <PRE> with Doxygen   (got a
> > > problem!)]
> > >
> > > Hi all,
> > > I have raised this issue a while ago. We are working on existing code
> > > and we need to maintains the CR-LF inside the paragraph lines.
> > > <PRE> and </PRE> does not help since it cause doxygen to ignore
> > > all tags between <PRE>   and </PRE>.
> > >
> > > The way we solve it is by writing a perl script that runs on the source
> > > code comments, copy them into temporary directory and add <BR> at
> > > the end of each line between paragraphs. Than we runs Doxygen on
> > > this directory.
> > >
> > > Doxygen is a very powerful tool, however the problem raised by Asko
> > > Kauppi limits the ability of the tool to process existing source code
> > > It would be nice to have a feature that will preserves any CR-LF exists
> > > in comments in between paragraphs.
> > >
> > > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > > Zvika Mizrahi
> > > Galileo Technology Ltd - a Marvell Company
> > > Tel : +972-4-9999555 ext. 1177
> > > Fax : +972-4-9999334
> > > zv...@ga...
> > > www.marvell.com
> > > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > >    << Message: [Doxygen-users] Using <PRE> with Doxygen   (got a
> > problem!)
> > > >>
> > ###########################################
> >
> > This message has been scanned by F-Secure Anti-Virus for Microsoft
> > Exchange.
> >
> > --
> > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > Zvika Mizrahi
> > Galileo Technology Ltd - a Marvell Company
> > Tel : +972-4-9999555 ext. 1177
> > Fax : +972-4-9999334
> > zv...@ga...
> > www.marvell.com
> > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > This message may contain confidential, proprietary
> > or legally privileged information. The information
> > is intended only for the use of the individual or
> > entity named above. If the reader of this message
> > is not the intended recipient, you are hereby
> > notified that any dissemination, distribution or
> > copying of this communication is strictly prohibited.
> > If you have received this communication in error,
> > please notify us immediately by telephone, or by
> > e-mail and delete the message from your computer.
> > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> >
> ###########################################
>
> This message has been scanned by F-Secure Anti-Virus for Microsoft Exchange.
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

--
Greger Haga
Available for hire...!
http://www.geocities.com/gregerhaga/pres/index.html
http://www.geocities.com/asdffi/eng/index.html
Winners never quit, quitters never win [Unknown]

[Doxygen-users] a weird problem with \class vs \ingroup

[Oliver S. <oli...@ut...>]

The order of \class and \ingroup seems to make a difference on output:

     /**
          \class Foo1
          \ingroup blabla
          Class that does something of no interest.
     */

     /**
          \ingroup blabla
          \class Foo2
          Class that doesn't do anything useful.
     */

If you generate the documentation and then go to the "blabla" module
page, you see:

     class Foo1
     class Foo2
         Foo2 is an abstract base class for windowing. [More...]

The brief description (here the first sentence of doc block) does not
show for Foo1 whereas it does for Foo2, this doesn't seem to make sense.
Also, the brief description showing for Foo2 is sort of handy, but the
[More] hyperlink is just extra clutter since Foo2 is already hyperlinked
to its docs.

I've notice same problem with \file vs \ingroup.  Are these bugs?

Oliver

[Doxygen-users] FW: source browser bug report and suggestion (resend)

[Darren B. <db...@ga...>]

This seemed to not get out the first time.  Let me try again.  --Darren

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

> I have two comments on the source browser function, one a probable bug,
> the second a change request which I'd like to propose to the community of
> users.
> 
> First, the bug report.  I believe I've found a bug in the source-browser
> links in the raw code files.   Apparently, a link that should be of the
> form "group page, anchor within group" is actually "file documentation
> page, anchor within group", which sends the link off to random space in
> the file documentation.
> 
> I have two source files, browser.dox and file.c.  All I did to the default
> configuration file is turn on the source browser.
> 
> File.c is simple: routine1 and routine2 are in group1, routine3 and
> routine4 are in group2.  (I'm sending attachments separately, to hopefully
> keep this message in plain text.  I honestly don't know what Outlook will
> do otherwise.)
> 
> This produces a page for file.c's raw source, with hyperlinks in function
> definitions, and references.  I copied and pasted a fragment below.
> Internet Explorer expands some of the otherwise-hidden link information.
> 
> The links to the far left (lines 25, 38, 50, etc.) are fine.  I indeed
> have two groups with two functions each.  What wasn't copied are the
> specific anchors a0 and a1.  (The full link is of the form
> group_group1.html#a0.)
> 
> The problem is the links by function names, which all link to
> file_8c.html.  Again, what isn't shown is that each of these links has an
> anchor a0 and a1, consistent with the routine's place in the group.
> File_8c.html appears to not have any anchors, so the link jumps to the top
> of the page.  In my actual code, I think structures and other elements in
> the file do create anchors, so the link jumps to an unrelated element in
> the same file.
> 
> Again, I think the fix would be rather simple.  All three links to
> routine1 would jump to the group page.  Although, this might get more
> complicated for functions that are not in a group, but are documented due
> to @file directives.
> 
> ------------------
> 00025 <group__group1.html> int routine1 <file_8c.html>(int x)
> 00026 {
> 00027     return( x );
> 00028 }
> 00029 
> 00030 
> 00038 <group__group1.html> int routine2 <file_8c.html>(int x)
> 00039 {
> 00040     return( routine1 <file_8c.html>(x) );
> 00041 }
> 00042 
> 00050 <group__group2.html> int routine3 <file_8c.html>(int x)
> 00051 {
> 00052     return( x );
> 00053 }
> 00054 
> 00055 
> 00063 <group__group2.html> int routine4 <file_8c.html>(int x)
> 00064 {
> 00065     return( routine3 <file_8c.html>(x) );
> 00066 }
> 00067 
> 00068 
> 00069 
> 
> ----------------
> 
> Second, I find the links in the browser a little counter-intuitive.  If I
> am in documentation, and I follow a "referenced by" link, I jump to source
> code.  If I am in source code, and I follow the link where one function
> calls another, I jump back to an (incorrect) documentation page.   I
> expected to see documentation "referenced by" links jump to documentation,
> and source-code references jump to source code.  For any given function, I
> can jump between code and documentation using the "Definition at line X"
> link, and the line number in the left column of source code.
> 
> Any opinions?  I imagine this is only worth changing if there is a clear
> consensus to do so.  Otherwise, so long as links go from source code to
> the correct documentation, I can traverse a code tree easily enough.
> 
> 
> Thanks,
>    Darren

[Doxygen-users] Email Rejected: Unknown or disallowed attachment type

[<ro...@vo...>]

Received: from [198.76.25.3] (HELO nns.voyanttech.com)
  by voyanttech.com (CommuniGate Pro SMTP 3.4b3)
  with SMTP id 2019190 for gle...@vo...; Thu, 14 Mar 2002 17:47:18 -0700
Received: from usw-sf-list1.sourceforge.net (usw-sf-fw2.sourceforge.net [216.136.171.252])
	by nns.voyanttech.com (8.9.3+Sun/8.9.3) with SMTP id SAA29384
	for <gle...@vo...>; Thu, 14 Mar 2002 18:45:32 -0500 (EST)
Received: from localhost ([127.0.0.1] helo=usw-sf-list1.sourceforge.net)
	by usw-sf-list1.sourceforge.net with esmtp (Exim 3.31-VA-mm2 #1 (Debian))
	id 16lfoI-00064F-00; Thu, 14 Mar 2002 16:43:06 -0800
Received: from harbormail.gadzoox.com ([216.52.31.23] helo=harbor.sjc.gadzoox.com)
	by usw-sf-list1.sourceforge.net with esmtp (Exim 3.31-VA-mm2 #1 (Debian))
	id 16lfnh-0005eq-00
	for <dox...@li...>; Thu, 14 Mar 2002 16:42:29 -0800
Received: by harbor.gadzoox.com with Internet Mail Service (5.5.2653.19)
	id <G91AHVP6>; Thu, 14 Mar 2002 16:42:41 -0800
Message-ID: <245...@ha...>
From: Darren Busing <db...@ga...>
To: dox...@li...
MIME-Version: 1.0
X-Mailer: Internet Mail Service (5.5.2653.19)
Content-Type: multipart/mixed;
	boundary="----_=_NextPart_000_01C1CBBA.4FA42E80"
Subject: [Doxygen-users] Source browser bug attachments
Sender: dox...@li...
Errors-To: dox...@li...
X-BeenThere: dox...@li...
X-Mailman-Version: 2.0.5
Precedence: bulk
List-Help: <mailto:dox...@li...?subject=help>
List-Post: <mailto:dox...@li...>
List-Subscribe: <https://lists.sourceforge.net/lists/listinfo/doxygen-users>,
	<mailto:dox...@li...?subject=subscribe>
List-Id: <doxygen-users.lists.sourceforge.net>
List-Unsubscribe: <https://lists.sourceforge.net/lists/listinfo/doxygen-users>,
	<mailto:dox...@li...?subject=unsubscribe>
List-Archive: <http://www.geocrawler.com/redir-sf.php3?list=doxygen-users>
X-Original-Date: Thu, 14 Mar 2002 16:42:40 -0800
Date: Thu, 14 Mar 2002 16:42:40 -0800

This message is in MIME format. Since your mail reader does not understand
this format, some or all of this message may not be legible.

------_=_NextPart_000_01C1CBBA.4FA42E80
Content-Type: text/plain;
	charset="iso-8859-1"

In case someone wants to re-create my problem from the previous email:

 <<file.c>>  <<browser.dox>>  <<file_8c-source.html>> 

------_=_NextPart_000_01C1CBBA.4FA42E80
Content-Type: application/octet-stream;
	name="file.c"
Content-Disposition: attachment;
	filename="file.c"

/**
@file file.c

Required to enable source browser functionality.

*/

/**
@defgroup group1 A group

*/

/**
@defgroup group2 A second group

*/

/**

The first routine in group 1

@ingroup group1

*/
int routine1(int x)
{
    return( x );
}


/**

The second routine, which calls the first.

@ingroup group1

*/
int routine2(int x)
{
    return( routine1(x) );
}

/**

The first routine in group 2

@ingroup group2

*/
int routine3(int x)
{
    return( x );
}


/**

The second routine in group 2, which calls the first.

@ingroup group2

*/
int routine4(int x)
{
    return( routine3(x) );
}




------_=_NextPart_000_01C1CBBA.4FA42E80
Content-Type: application/octet-stream;
	name="browser.dox"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: attachment;

FOR ANTI-VIRUS SECURITY, THIS EMAIL HAS BEEN CLEANED.

REASON:
THIS EMAIL CONTAINED AN ATTACHMENT TYPE OF '.dox' WHICH IS NOT PERMITTED.

[Doxygen-users] Source browser bug attachments

[Darren B. <db...@ga...>]

In case someone wants to re-create my problem from the previous email:

 <<file.c>>  <<browser.dox>>  <<file_8c-source.html>> 

[Doxygen-users] source browser bug report and suggestion

[Darren B. <db...@ga...>]

I have two comments on the source browser function, one a probable bug, the
second a change request which I'd like to propose to the community of users.

First, the bug report.  I believe I've found a bug in the source-browser
links in the raw code files.   Apparently, a link that should be of the form
"group page, anchor within group" is actually "file documentation page,
anchor within group", which sends the link off to random space in the file
documentation.

I have two source files, browser.dox and file.c.  All I did to the default
configuration file is turn on the source browser.

File.c is simple: routine1 and routine2 are in group1, routine3 and routine4
are in group2.  (I'm sending attachments separately, to hopefully keep this
message in plain text.  I honestly don't know what Outlook will do
otherwise.)

This produces a page for file.c's raw source, with hyperlinks in function
definitions, and references.  I copied and pasted a fragment below.
Internet Explorer expands some of the otherwise-hidden link information.

The links to the far left (lines 25, 38, 50, etc.) are fine.  I indeed have
two groups with two functions each.  What wasn't copied are the specific
anchors a0 and a1.  (The full link is of the form group_group1.html#a0.)

The problem is the links by function names, which all link to file_8c.html.
Again, what isn't shown is that each of these links has an anchor a0 and a1,
consistent with the routine's place in the group.  File_8c.html appears to
not have any anchors, so the link jumps to the top of the page.  In my
actual code, I think structures and other elements in the file do create
anchors, so the link jumps to an unrelated element in the same file.

Again, I think the fix would be rather simple.  All three links to routine1
would jump to the group page.  Although, this might get more complicated for
functions that are not in a group, but are documented due to @file
directives.

------------------
00025 <group__group1.html> int routine1 <file_8c.html>(int x)
00026 {
00027     return( x );
00028 }
00029 
00030 
00038 <group__group1.html> int routine2 <file_8c.html>(int x)
00039 {
00040     return( routine1 <file_8c.html>(x) );
00041 }
00042 
00050 <group__group2.html> int routine3 <file_8c.html>(int x)
00051 {
00052     return( x );
00053 }
00054 
00055 
00063 <group__group2.html> int routine4 <file_8c.html>(int x)
00064 {
00065     return( routine3 <file_8c.html>(x) );
00066 }
00067 
00068 
00069 

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

Second, I find the links in the browser a little counter-intuitive.  If I am
in documentation, and I follow a "referenced by" link, I jump to source
code.  If I am in source code, and I follow the link where one function
calls another, I jump back to an (incorrect) documentation page.   I
expected to see documentation "referenced by" links jump to documentation,
and source-code references jump to source code.  For any given function, I
can jump between code and documentation using the "Definition at line X"
link, and the line number in the left column of source code.

Any opinions?  I imagine this is only worth changing if there is a clear
consensus to do so.  Otherwise, so long as links go from source code to the
correct documentation, I can traverse a code tree easily enough.


Thanks,
   Darren

[Doxygen-users] Bug? A Class visible in the module page, but it shows undocumented until you assign it a @brief

[Evil K. <evi...@ya...>]

Hi everyone.

I dont know whether this is another bug, but when you add a class to a 
group, it's assigned into the appropriate place in the Modules Page right, 
well, has anyone noticed, if you dont give the class or struct a @brief 
statement, the class isnt available for view, you can't click the classname 
and see the class like you can normally, I Dont know why this is the 
situation, this is a more detailed explanation of my situation and what 
happened

I have a class, I'll rip out the insides and just give the basic information

/**	@class		Entity
  *	@ingroup	Mesh_Graphics_Group
  */
class Entity{
protected:
	/* Blah */
public:
	/* Blah */
};

The groups are defined as such:

/**	@defgroup	Graphics_Group	Graphics Subsystem */

/**	@defgroup	Mesh_Graphics_Group	Mesh Classes
  *	@ingroup	Graphics_Group
  */

Now, when I processed the code with doxygen everything else was fine, 
except for the class above and others like it, adding a @brief statement 
meant they were available, but until then, it was like the class wasnt 
documented or something

/**	@class		Entity
  *	@ingroup	Mesh_Graphics_Group
  *	@brief		A brief explanation
  */
class Entity{
protected:
	/* Blah */
public:
	/* Blah */
};

Now THIS works ok, the only change is the @brief statement

To test the idea about this situation, I went and took out the @brief 
statement I had with a class I knew was documented, as expected, it also 
displayed itself as not documented.  I'm not aware that you MUST HAVE a 
@brief statement, I was under the impression they were additional 
information you COULD add if you wanted to.  SO! Does this qualify as 
another bug?  And yeah yeah, I *could* fix it, but I find the code is kinda 
undocumented (how ironic) and I can't follow it because I simply dont 
understand what it's doing, but thats my fault I think, so the only thing I 
can do is suggest bugs and see what people say

oki doki, guys, ta ta

kosh


_________________________________________________________
Do You Yahoo!?
Get your free @yahoo.com address at http://mail.yahoo.com

Re: [Doxygen-users] Limited Support for VB should be easy?

[Alexander L. <li...@we...>]

<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
Hi,
<p>one could write an input filter for VB files which removes the VB comment
sign just
<br>before passing the files to doxygen ...
<br>i am also very interested to document all that VB crap with doxygen
also, but never tried
<br>it ... does doxygen include the sources as well and is able to cross-link
the sources?
<p>Alex
<p>Dav...@ho... schrieb:
<blockquote TYPE=CITE>Hi all.
<br>Well, I inherited a VBasic project, without little documentation. I
love
<br>using doxygen to document my C++ projects and don't want to use anything
<br>else... but... No support for VB..
<br>so with a little digging... It seems I should be able
<br>to use doxygen with vb if there is a way to have it ignore
<br>the VB comment delimiter. I will need to use the long
<br>hand method to create file and function comments
<br>e.g.
<br>'
<br>'/*!
<br>'// \fn MyPatheticVBfunction(one AS integer)
<br>'//&nbsp;&nbsp;&nbsp;&nbsp; yadda yadda description..
<br>'*/
<p>Now this does not work because of the ' (single quote) delimiter for
the
<br>comment.. But when I remove the ' from the file as a comment delimiter,
<br>I get nice doxygen output.
<p>But, VBasic must have the ' for comments (I wish VB would also use //,
<br>but alas.. no)
<p>While using the long handed method is not the best, it still gives me
<br>a workable solution.
<p>So, again. Is there a way to specify the doxygen to ignore any ' (tick)?
<br>This could alow me to use doxygen for VB.
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Dave Foringer
<br>> Honeywell BRGA FMS
<br>> *Tel: 602-436-3036
<br>> *Email:dav...@ho...
<br>>
<p>_______________________________________________
<br>Doxygen-users mailing list
<br>Dox...@li...
<br><a href="https://lists.sourceforge.net/lists/listinfo/doxygen-users">https://lists.sourceforge.net/lists/listinfo/doxygen-users</a></blockquote>

<pre>--&nbsp;
Alexander Lichius
Diplom-Ingenieur
Communication and Information Systems
Werum Software &amp; Systems AG&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
Wulf-Werum-Strasse 3 | D-21337 Lueneburg
Tel. +49 4131 8900-623 | Fax +49 4131 8900-20&nbsp;
<A HREF="mailto:li...@we...">mailto:li...@we...</A> | <A HREF="http://www.werum.de">http://www.werum.de</A></pre>
&nbsp;</html>

[Doxygen-users] Doxygen: metrics utility

[Martin B. <MBo...@op...>]

Thanks Dimitri.

I have mistakenly assumed that the metrics utility was available in the
binary distributions.

Unfortunately i have forgotten to mention that i am using WIN NT. I have got
the source but couldn't successfully run the configure perl program or make.
Unless this is a trivial exercise i think i will give it a miss until there
is a binary.

Martin.


On Wed, Mar 13, 2002 at 09:45:22AM +1000, Martin Bosticky wrote:
> Hi everyone.
>  
> In the change.log file i have found a new feature being a metrics utility.
> However i am having trouble following the instructions to get it. Can
anyone
> help me?

Here are some quick instructions (for Unix):

Get the source distribution from CVS. Run configure. Go to the
addon/doxmlparser/src dir and run make. Then go to 
addon/doxmlparser/examples/metrics dir and run make again. If all went well
you have an executable "metrics" in this dir, which you can run with the
name of a directory containing doxygen-generated XML output as the only 
argument.

I hope this helps,

Regards,
  Dimitri

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

RE: [Doxygen-users] Doxygen: metrics utility

[Martin B. <MBo...@op...>]

Thanks Dimitri.

I have mistakenly assumed that the metrics utility was available in the
binary distributions.

Unfortunately i have forgotten to mention that i am using WIN NT. I have got
the source but couldn't successfully run the configure perl program or make.
Unless this is a trivial exercise i think i will give it a miss until there
is a binary.

Martin.

On Wed, Mar 13, 2002 at 09:45:22AM +1000, Martin Bosticky wrote:
> Hi everyone.
>  
> In the change.log file i have found a new feature being a metrics utility.
> However i am having trouble following the instructions to get it. Can
anyone
> help me?

Here are some quick instructions (for Unix):

Get the source distribution from CVS. Run configure. Go to the
addon/doxmlparser/src dir and run make. Then go to 
addon/doxmlparser/examples/metrics dir and run make again. If all went well
you have an executable "metrics" in this dir, which you can run with the
name of a directory containing doxygen-generated XML output as the only 
argument.

I hope this helps,

Regards,
  Dimitri

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

[Doxygen-users] Limited Support for VB should be easy?

[<Dav...@ho...>]

Hi all.
Well, I inherited a VBasic project, without little documentation. I love
using doxygen to document my C++ projects and don't want to use anything
else... but... No support for VB..
so with a little digging... It seems I should be able
to use doxygen with vb if there is a way to have it ignore
the VB comment delimiter. I will need to use the long
hand method to create file and function comments
e.g.
'
'/*!
'// \fn MyPatheticVBfunction(one AS integer)
'//     yadda yadda description..
'*/

Now this does not work because of the ' (single quote) delimiter for the
comment.. But when I remove the ' from the file as a comment delimiter,
I get nice doxygen output.

But, VBasic must have the ' for comments (I wish VB would also use //,
but alas.. no)

While using the long handed method is not the best, it still gives me
a workable solution.

So, again. Is there a way to specify the doxygen to ignore any ' (tick)?
This could alow me to use doxygen for VB.


	Dave Foringer
> Honeywell BRGA FMS
> *Tel:	602-436-3036
> *Email:dav...@ho...
> 

RE: [Doxygen-users] Using @link to reference a file

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

I had a tough time getting Doxygen to understand my links even when
using the <a href...> form. It coughed and choke the most on relative
paths.
=20
My solution was to insert something that I'd recognize, post-process the
file, and replace it with what was needed.
=20
I was already post processing the file to add navigation to the top and
copyright info to the bottom, anyway. Looking for my flags and replacing
them with something that worked was a minor extra step.
=20
Because I'm already post-processing, I'd be inclined to not use your
ALIAS definitions but to keep the @mylink and @endmylink delimiters. I'd
let them be the flags for the post-processor.
=20
Not what you were expecting.
=20
I have some open-source tools for post-processing (voyant_nav.pl)
available at www.voyanttech.com/tp_tools.zip (1.8 MB). Unzip and launch
tp_tools/_start_here.zip. Look up the perl programs (voyant_nav.pl).
=20
HTH
=20
Glenn

-----Original Message-----
From: Kevin Williams [mailto:KWi...@vi...]
Sent: Wednesday, March 13, 2002 11:08 AM
To: dox...@li...
Subject: RE: [Doxygen-users] Using @link to reference a file



Alright, I figured out how to make my alias ALMOST work.  Here's what
I've got:=20

  ALIASES  =3D "mylink=3D@htmlonly<a =
href=3D\"../Properties.html#@endhtmlonly"

  ALIASES +=3D "endmylink=3D@htmlonly\">View Properties</a>@endhtmlonly" =


Here's how it would be used:=20

  /**=20
   * A Cat object.=20
   *=20
   * @mylink Cat @endmylink=20
   */=20
  interface Cat=20
  {=20
  }=20

Here's what it produces:=20

  <a href=3D"../Properties.html# Cat">View Properties</a>=20

Note this space --------------^=20

I just need to get rid of that space!  Anyone have any ideas on that
one?=20

-- Kevin Williams=20
   Visionael Corporation=20
   kwi...@vi...=20