udbComment

Description

Returns a formatted string based on comments associated with a given entity.

Syntax

#include “udb/udb.h” 
char * udbComment(UdbEntity entity, 
                  UdbCommentStyle style, 
                  UdbCommentFormat format, 
                  UdbKindList kinds) 

Arguments

Argument
Description
UdbEntity entity
Specify the entity.
UdbCommentStyle style
Specify the comment style.
UdbCommentFormat format
Specify the comment format.
UdbKindList kinds
If not NULL, entity kinds to filter.

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.

UdbCommentFormat specifies what kind of formatting, if any, is applied to the comment text. The valid value is:

Argument Values
Description
Udb_commentFormatDefault
Removes comment characters and certain repeating characters, while retaining the original newlines. (Use udbCommentRaw to return the raw comment string.)

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

Return Values

Return Values
Description
char *
Pointer to the string of comments returned.

See Also

udbCommentRaw


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