Re: [Doxygen-users] Assembly Language

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

David-
Our code has a C-style .H file for each .asm file, too. Something like
this:

#ifndef _FUNC_TEST_H
#define _FUNC_TEST_H
/***********************************************************************
**
 *
 * Module Name:  FUNCTIONAL.H
 *
 * Author: <author's name>
 *
 * Version history:
 *
 *   $Log: FUNCTIONAL.H $
 *   Revision 1.2  2005/09/28 16:00:06  EngLab-1
 *   Revision 1.1  2005/05/05 19:05:11  kstone
 *   Initial revision
 *
=20
************************************************************************
*/
extern "C" unsigned int functional_test(void);
#endif=20

=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
The ASM file does NOT include this file at all - it's there to be
included by the various C files that need access to the functions that
XXX.H provides. Note that there aren't any Doxygen tags in this file
either. We put all of that over in the XXX.ASM file for the same reasons
you mentioned - to keep the code and documentation close together.


-----Original Message-----
From: dox...@li...
[mailto:dox...@li...] On Behalf Of
Relson, David
Sent: Monday, June 04, 2007 4:22 PM
To: Dox...@li...
Subject: Re: [Doxygen-users] Assembly Language

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


------------------------------------------------------------------------
-
This SF.net email is sponsored by DB2 Express Download DB2 Express C -
the FREE version of DB2 express and take control of your XML. No limits.
Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users