udbComment |
Returns a formatted string based on comments associated with a given entity.
#include “udb/udb.h” char * udbComment(UdbEntity entity, UdbCommentStyle style, UdbCommentFormat format, UdbKindList kinds)
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:
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.
Scientific Toolworks, Inc. http://www.scitools.com |