BUG: Aliases not formatted
2005-05-26 14:41:17 GMT
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)
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.
Ret_Type ExampleFunction (Object *p, InstNum a, Mode oMode, HwSetup *q);
*p Pointer to the Object
a The Instance Number (InstNum)
oMode The desired Open Mode
*q Pointer to the HwSetup structure
This is the pre-condition
status = Open(myExample, 1, .........)
DEF_OK = Successful open
Other value = Open failed (Error code is returned.)
doThis, doThat, doNothing
OMAP™ Program Facilitation Office