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

Helper class to deal with C# XML comments.
Show file Open project: Monobjc/monobjc-tools

Public Methods

Method 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 method

Extracts the availability version.
public static ExtractAvailability ( String comment ) : String
comment String The comment.
return String

GetAvailability() public static method

Gets the availability formatted string.
public static GetAvailability ( String version ) : String
version String The version.
return String

IsAvailability() public static method

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

IsDeclaration() public static method

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

IsParagraph() public static method

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

IsParameter() public static method

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

IsRemarks() public static method

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

IsReturn() public static method

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

IsSignature() public static method

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

IsSummary() public static method

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