C# Class Monobjc.Tools.Generator.Utilities.CommentHelper

Helper class to deal with C# XML comments.
Afficher le fichier Open project: Monobjc/monobjc-tools

Méthodes publiques

Méthode Description
ExtractAvailability ( String comment ) : String

Extracts the availability version.
GetAvailability ( String version ) : String

Gets the availability formatted string.
IsAvailability ( String comment ) : bool

Determines whether the specified comment is an availability.
IsDeclaration ( String comment ) : bool

Determines whether the specified comment is a declaration.
IsParagraph ( String comment ) : bool

Determines whether the specified comment is a paragraph.
IsParameter ( String comment ) : bool

Determines whether the specified comment is a parameter.
IsRemarks ( String comment ) : bool

Determines whether the specified comment is remarks.
IsReturn ( String comment ) : bool

Determines whether the specified comment is a return.
IsSignature ( String comment ) : bool

Determines whether the specified comment is a signature.
IsSummary ( String comment ) : bool

Determines whether the specified comment is a summary.

Method Details

ExtractAvailability() public static méthode

Extracts the availability version.
public static ExtractAvailability ( String comment ) : String
comment String The comment.
Résultat String

GetAvailability() public static méthode

Gets the availability formatted string.
public static GetAvailability ( String version ) : String
version String The version.
Résultat String

IsAvailability() public static méthode

Determines whether the specified comment is an availability.
public static IsAvailability ( String comment ) : bool
comment String The comment.
Résultat bool

IsDeclaration() public static méthode

Determines whether the specified comment is a declaration.
public static IsDeclaration ( String comment ) : bool
comment String The comment.
Résultat bool

IsParagraph() public static méthode

Determines whether the specified comment is a paragraph.
public static IsParagraph ( String comment ) : bool
comment String The comment.
Résultat bool

IsParameter() public static méthode

Determines whether the specified comment is a parameter.
public static IsParameter ( String comment ) : bool
comment String The comment.
Résultat bool

IsRemarks() public static méthode

Determines whether the specified comment is remarks.
public static IsRemarks ( String comment ) : bool
comment String The comment.
Résultat bool

IsReturn() public static méthode

Determines whether the specified comment is a return.
public static IsReturn ( String comment ) : bool
comment String The comment.
Résultat bool

IsSignature() public static méthode

Determines whether the specified comment is a signature.
public static IsSignature ( String comment ) : bool
comment String The comment.
Résultat bool

IsSummary() public static méthode

Determines whether the specified comment is a summary.
public static IsSummary ( String comment ) : bool
comment String The comment.
Résultat bool