25 May 2005 01:03

Patch: Preprocessing DOT input files

Hi there,

There was a post on the doxygen-users list a few days ago asking if it is
possible to do something like the following:

/** blah blah
\dot
graph G {
a -- b
#if defined(ENABLE_C)
b -- c
c -- a
#endif
}
\enddot

*/

Basically this allows showing or hiding of nodes based on the pre-processor
defines.  As far as I've been able to workout, this cannot be done without
invoking an external pre-processor as part of a build step or script.

This feature is something I very much want, as I have a large diagram with a
few small parts which are optional depending on compile switches.  DOT
itself seems to like the idea of pre-processing as it ignores any lines that
start with a # character, so is safe to ignore and '#line' output, were the
pre-processor to make any.

There follows a patch that adds an option "PREPROCESS_DOT_FILES" to allow
DOT input files to be preprocessed.  I would be very grateful to know if


26 May 2005 16:41

BUG: Aliases not formatted

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( )
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>
#include <node.h>
Syntax:

Ret_Type ExampleFunction (Object *p, InstNum a, Mode oMode, HwSetup *q);

Path

\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 = Open(myExample, 1, .........)

Returns:

DEF_OK = Successful open
Other value = Open failed (Error code is returned.)

doThis, doThat, doNothing

Library:

Example Library

Regards,
Larry Randall
OMAP™ Program Facilitation Office

27 May 2005 15:18

Re: BUG: Aliases not formatted

On 5/26/05, Randall, Larry <l-randall <at> ti.com> wrote:
>
>
> 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.

Ok, but you didn't mention how these aliases are defined. I could
imagine that is the
source of the problem, but at least this information is required to
reproduce the
problem. I would prefer that a bug report is filed with a self
contained example as
an attachment.

Regards,
Dimitri

-------------------------------------------------------
This SF.Net email is sponsored by Yahoo.
Introducing Yahoo! Search Developer Network - Create apps using Yahoo!
Search APIs Find out how you can build Yahoo! directly into your own