Paul Floyd | 1 Feb 11:07 2007
Picon

Problems with #includes within structs and duplicated macros

Hi

I'm woeking on a big project written mainly in ugly C. The documentation is
patchy, and I'm trying to generate doxygen docs for it.

However, there are quite a few issues that I'm having.

The first one, for at least one struct, the code looks like this

typedef struct FOO_S {
  struct desc d;
#include "common1.inc"
  MORE_MEMBERS;
  DECL_MACRO(frob);
#include "common2.inc"
  int *bar;
   ...
} FOO;

inside 'common1.inc', it is pretty much more of the same:

#include "common3.inc"
int aaa;
int bbb;

MORE_MEMBERS just expands to some more POD data types.

DECL_MACRO does something like

#define DECL_MACRO(O) struct U_##O ** O##s; unsigned int O##s_count;
(Continue reading)

Rene Hartmann | 1 Feb 21:47 2007
Picon

Re: #include in function documentation

Kevin McBride wrote:
> Rene Hartmann wrote:
>> I want to put an #include above a function in the documentation like
>> the following:
>>
>>
>> #include <myhdr.h>
>>
>> int myfunc(int myarg);
>>
>>
>> Is there any way to do this with Doxygen? It seems to be possible ony
>> for structs and classes.
>>
> 
> You may want to try using the  <at> include command:
> 
> http://www.stack.nl/~dimitri/doxygen/commands.html#cmdinclude
> 
This command does not generate an #include comment, it includes
a file into the documentation, which is not quite what I want.

René Hartmann

-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier.
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
(Continue reading)

hartnett_mildred | 1 Feb 23:30 2007

question about inheritance graphs

Is there a configuration flag that can be set to limit the number of
inheritances that are displayed in the graphical representation? I only
want to go down 2, maybe 3 levels. But I have some that are trying to
graph down 5 or 6 levels and the graph is huge.

Thanks for any help you can give me.

Millie Hartnett

-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier.
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
Volker Hartmann | 2 Feb 14:27 2007
Picon

Re: Problem parsing attributes in C#

Hi Clemens,

> Seems that you use some non-standard compiler features, don't you.
I don't think so. I also use attributes for serializing objects to XML
and that should be a standard feature, shouldn't it?

> On 5 Jan 2007 someone had a similar problem. Please read the thread 
> named "Newbie Doxygen DLL extern question".
OOPS! I searched for similar problems, but the header is not very
meaningful. ;-)

After sending my mail I found a bug similar to my problem I found it
in the buglist. (http://bugzilla.gnome.org/show_bug.cgi?id=402452)
I think I checked this some seconds before this entry exists!?

> Basicly you have 3 options to get avoid confusing doxygen with those 
> non-standard stuff.
> 
> A)
> Preprocessor
OK, that's not my favourite, because I don't want to change the code
and make it less readable. Of course it's already hard to read.

> B)
> Doxygen conditionals
see A)

> C)
> Build Regular expression input filter for doxygen processing (for 
> example with SED)
(Continue reading)

Catenacci, Onorio | 2 Feb 14:52 2007
Picon

Re: Problem parsing attributes in C#

Hi Clemens, Volker, et. al.,

What Volker is doing isn't non-standard in C# as far as I know.  Perhaps
others have a better grasp of C# syntax than I do but I think what's
he's doing is pretty standard for C#.  

Volker, while there is support for C#, doxygen is really rooted in C++
and that's what it supports best.  Attributes are specific to C# (well,
.NET really but why split hairs?) so there's unlikely to ever be direct
support for them in doxygen.  You'll need to look at the doxygen C#
parser and see what it does with attributes.  

Just my $.02

--
Onorio 

-----Original Message-----
From: doxygen-users-bounces <at> lists.sourceforge.net
[mailto:doxygen-users-bounces <at> lists.sourceforge.net] On Behalf Of Volker
Hartmann
Sent: Friday, February 02, 2007 8:27 AM
To: doxygen-users <at> lists.sourceforge.net
Subject: Re: [Doxygen-users] Problem parsing attributes in C#

Hi Clemens,

> Seems that you use some non-standard compiler features, don't you.
I don't think so. I also use attributes for serializing objects to XML
and that should be a standard feature, shouldn't it?
(Continue reading)

Clemens Feige | 2 Feb 16:08 2007

Re: Problem parsing attributes in C#


On 2 Feb 2007 at 11:08, Volker Hartmann wrote:
> Hi Clemens,

> > Build Regular expression input filter for doxygen processing 
> > (for  example with SED)

> it sounds really easy, but I can't get it run!?
> OK, I think I found the correct RegExp 
> (s/^[:space:]*\[.*[(].*[)].*].*$//)
> but doxygen fails with something like
> 'the given program couldn't be execute'
> (Das angegebene Programm kann nicht ausgefuehrt werden.)
> (Version 1.5.1-p1, with the old version 1.4.7 it fails
> without any error message.)
> SED works fine on the command line!
> I also tried to wrap the parameters in a batch file,
> without any success.
> BTW: Of course I'm using windows.
> Should I try it in linux?

Hi Volker.

I must admit that my C# experience is very limited.
(Onorio has quickly discovered this)

I think your problem relates to wrong quoting (see point #3 below).

You should check the following steps for your problem:

(Continue reading)

thedman | 5 Feb 06:58 2007

Documenting Cross-Platform Code

Hi

We have a cross platform codebase which we'd like to document with Doxygen.

Our code contains a lot of blocks similar to this:

#if defined(PLATFORM_1)
     ///\ingroup Platform1
     ///\brief Platform 1 platform specific function.
     void Platform1SpecificFunc();

#elif defined(PLATFORM_2)
     ///\ingroup Platform2
     ///\brief Platform 2 platform specific function.
     void Platform2SpecificFunc();

#elif defined(PLATFORM_3)
     ///\ingroup Platform3
     ///\brief Platform 3 platform specific function.
     void Platform3SpecificFunc();

#else
     #error "No suitable platform defined."

#endif

Is there any way to convince Doxygen to document all three functions  
simultaneously? (We have a similar issue trying to simultaneously  
document debug & release configurations - we can live with only  
generating documentation for the release configurations, but hopefully  
(Continue reading)

Volker Hartmann | 5 Feb 10:38 2007
Picon

Re: Problem parsing attributes in C#

Hi Clemens,

> #1
> Test that SED runs from the commandline.
> of course you'll need to edit PATH or have SED in your local path.
on commandline it works fine!

> Myself, I have SED not in global PATH, I simply store the required 
> files for SED in the same path as doxygen:  
> 
> - sed.exe
> - libiconv2.dll
> - libintl3.dll
OOPS! There are no DLLs in my SED version!
I used the GNU sed v3.02.80 for Windows (3x, 9x, NT, 2K)
(sed.sourceforge.net)

Now I tried another one:
  super sed v3.59 for Windows by Paolo Bonzini
With this version it succeeds!?
Don't know what's the difference!

P.S.: On linux I use the version:
GNU sed version 4.1.4

> #3
> Call SED as doxygen input filter. I believe here seems to be your
> problem. Here is my config line (to remove xxx in this example).
> 
> INPUT_FILTER           = "sed  -r s/xxx//"
(Continue reading)

Bob Lied | 5 Feb 14:23 2007

A vote for <at> cmd

A few months ago, there was a proposal to add a generalized  <at> cmd
http://sourceforge.net/mailarchive/message.php?msg_id=15551916

Having just looked at the patch, I think it would be a useful
addition.  The originator seems willing to add the code, so what
would it take to move this onto the todo list?
--

-- 
Bob Lied
Attachment (lied.vcf): text/x-vcard, 529 bytes
-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier.
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
Doxygen-users mailing list
Doxygen-users <at> lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Justin Randall | 5 Feb 20:06 2007
Picon

Ignoring a small section of C comments

Hi,

I have a question for the doxygen experts out there. I want to be able
to cut out a small piece of the beginning and end of my C comments in
doxygen. I like nice neat comment blocks in my code, and at the moment
this is an example of what I have.

/** --------------------------------------------------------------------
 *  <at> brief Used to shift off bits we don't care about
 ----------------------------------------------------------------------*/
#define BIT_MASK 16

Now this works fine, but I want to be able to make doxygen ignore the
--------------------------------------------------------------------
lines so that my documentation looks neat. Is there something I can do
besides putting the dashed lines outside the doxygen comment block? Is
there some configuration option for this? I looked though the
configuration manual and could not find any answers. Any help is
appreciated thank you. Here is my config file.

PROJECT_NAME         = "Temp"
PROJECT_NUMBER       = "Version 1.0"
OUTPUT_DIRECTORY     = docs
HAVE_DOT             = NO
EXTRACT_ALL          = YES
GENERATE_LATEX       = NO
GENERATE_MAN         = NO
GENERATE_RTF         = NO
CASE_SENSE_NAMES     = NO
ENABLE_PREPROCESSING = YES
(Continue reading)


Gmane