Re: [Doxygen-users] Assembly Language

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

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:

//**********************************************************************
/**=20
* @fn bool GetPLLValue(int X, int Y, int Z)
*=20
* @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
*=20
**********************************************************************/
/// @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