[Doxygen-users] Separating comments from the code item

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

Hi all,

I'm having problems developing a special-case scheme to keep doxygen
comments separate from the source files. I've gotten this to work for
functions (@fn) by supplying the exact prototype.=20

I have not made this work for enumerations (@enum) or typedef's
(@typedef); it doesn't match on short definitions (@typedef enum BOGUS)
or on long definitions (@typedef enum BOGUS {one=3D1; two=3D2} BOGUS;) =
that
try to put in the exact syntax on one line. (We are using the "typedef
enum" syntax.) The long definitions are also cumbersome.

Why do I have this problem?

Our developers do a lot of code generation. This means that the input
files to Doxygen sometimes are generated from one or more source files
by one or more other tools first. Those tools do not pass comments
through. I would normally be exploring updating the tools to pass the
comments through, but we don't have control over all of the code
generation tools.

My goal is to get comments closer to the source code so that they remain
up-to-date and accurate. Right now, I have the information in FrameMaker
that gets exported into the HTML system. Doxgyen exports prototypes into
the HTML system, but there is nothing that tells you about the code
item. If you happen to find it using the index, you'll see both
references and get all needed info. If you access through the doxygen
portion alone, you'll be left hanging (what is this?)

Any ideas on how I can still get the syntax accuracy of Doxgyen together
with the detailed descriptions?

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