Re: [Doxygen-users] Assembly Language

[Kevin S. <st...@se...>]

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

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

Hi Kevin,

Thanks for the suggestion!

Making the ASM code "look" like C lets Doxygen generate call graphs,
which is highly useful for learning the structure of new code.  However,
since the current task is a documentation task and the graphs aren't
needed, I can skip the "look like" steps.

However, following your example of a function header and @cond/@endcond
tags produces Doxygen output where my test file's source code page is
fine, but the document page lacks the function info or other useful
stuff and just says "Go to the source code of this file."

Any further thoughts?

Regards,

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

David-
For my embedded ASM code, I'm using the @cond/@endcond Doxygen tags to
tell Doxygen to ignore the actual assembly code. Something like this:

//**********************************************************************
/**
* @fn bool GetPLLValue(int X, int Y, int Z)
*
* @brief Get the PLL data value for the specified device.
*
* This function returns ...blah blah blah
*=20
* @param[in] 	X 	integer, frequency of system clock in MHz
* @param[out]	Y 	ptr to an integer, the resultant PLL count
* @param[in,out]	Z 	ptr to an integer, the scale factor
*
* @retval 	bOK	boolean, TRUE if everything went well
*
**********************************************************************/
/// @cond DOXYGEN_IGNORE_ASM
GetPLLValue:
.
.
.
<insert the real assy code here>
.
.
.
/// @endcond


You don't have to do a bunch of work to the ASM file to make it "look"
like a C file for Doxygen.
Read up on this in the manual for more details.

-Kevin Stone