Re: [Doxygen-users] Assembly Language

[Relson, D. <dav...@as...>]

Hi Kevin,

I was hoping to include doxygen tags in the asm file itself, but that no
longer seems feasible.

It seems that doxygen needs a C function definition/prototype before it
will put the function info in the generated html documentation.  As the
assembler will choke on a C function declaration, this won't work.

The alternate solution is an include.h file.  This has the drawback of
code in one file and documentation in a different file.  The benefit is
that this allows all the functions to be included in the doxygen output.
As the benefit outweighs the drawback, so shall it be.

Thanks for the tips leading to a workable solution.

Regards,

David

-----Original Message-----
From: Kevin Stone [mailto:st...@se...]=20
Sent: Monday, June 04, 2007 3:41 PM
To: Relson, David; Dox...@li...
Subject: RE: [Doxygen-users] Assembly Language

Hi, David-
The @fn and @brief tags that are in our headers end up creating the call
graph and other useful function details that you're looking for. I just
re-ran my stuff and found that it shows up in the XXXX.h File Reference
section. There is a list of the functions (and their brief descriptions)
in each asm file, and then a block of "Functional Documentation" for
each function, with the description, in/out params, return values,
notes, etc, and the caller graph. All of this is right after the "Go to
the source code of this file" link.

-Kevin