Dimitri,
In the 1.3.7 era, an alias was formatted in RTF output exactly as a =
Parameter, &c. This formatting was lost somewhere between 1.3.7 and =
1.4.1.
The actual formatted output appears below. "Syntax", "Path", and =
"Library" are aliases.
We, along with most others who need printable documentation in a strict =
format, must have the output in a defined format - using our approved =
styles. [ We are stuck with Word as our "text processor". :-( ] I =
have created a style sheet that converts the Doxygen styles to our =
styles. Unfortunately, the style used for aliases is a text style - not =
a heading - and it does not match the style used for "Parameters".
(We would also prefer that the heading be the function without =
arguments: i.e., "ExampleFunction()".) REASON: The "Ret_Type =
ExampleFunction (Object * p, InstNum a, Mode oMode, HwSetup * q)" is not =
as clear, and long headings create problems in the Table of Contents for =
printed documents. This explains why we chose to have the syntax shown.
Fixing these problems leads to enormous amounts of wasted time, and =
makes it difficult to use Doxygen.
Ret_Type ExampleFunction (Object * p, InstNum a, Mode oMode, HwSetup * =
q)
ExampleFunction( )=20
The ExampleFunction( ) call sets up the data structures for the =
particular instance of the device. It also checks for the availability =
of resource and flags error if it is not available. Hardware setup will =
be performed at the end of the open call only if the HwSetup Pointer =
supplied as the argument is not NULL.
#include <ialg.h>=20
#include <node.h>
Syntax:=20
Ret_Type ExampleFunction (Object *p, InstNum a, Mode oMode, HwSetup =
*q); =20
Path =20
\this\path\here
Parameters:
*p Pointer to the Object
a The Instance Number (InstNum)
oMode The desired Open Mode
*q Pointer to the HwSetup structure
Precondition:
This is the pre-condition
Postcondition:
status =3D Open(myExample, 1, .........)
Returns:
DEF_OK =3D Successful open
Other value =3D Open failed (Error code is returned.)=20
See also:
doThis, doThat, doNothing
Library:=20
Example Library
Regards,=20
Larry Randall =20
OMAP(tm) Program Facilitation Office=20
|
