udbCommentRaw

Description

Returns a raw comment string based on comments associated with a given entity.

Syntax

#include “udb/udb.h” 
void udbCommentRaw(UdbEntity entity,  
                   UdbCommentStyle style, 
                   UdbKindList kinds, 
                   char ***commentString, 
                   int *) 

Arguments

Argument
Description
UdbEntity entity
Specify the entity
UdbCommentStyle style
Specify the comment style.
UdbKindList kinds
If not NULL, entity kinds to filter.
char ***commentString
Pointer to the raw comment string returned.
int *len
Returns the number of comments.

UdbEntity specifies the entity for which comments are to be returned.

UdbCommentStyle specifies which comments are to be used. By default, comments after the entity declaration are processed. The valid values are:

Argument Values
Description
Udb_commentStyleDefault
or
Udb_commentStyleAfter
Process comments after the entity declaration. (This is the default.)
Udb_commentStyleBefore
Process comments before the entity declaration.

UdbKindList is a language-specific reference filter string to specify which kinds of entities should be matched.

Return Values

There is no return value.

See Also

udbComment


Scientific Toolworks, Inc.
http://www.scitools.com