C# Class YAMP.Help.Documentation

Represents the documention in as an object.

Public Methods

Method	Description
ClosestEntry ( String entry ) : String	Finds the closest entry to the given entry.
ContainsEntry ( String entry ) : System.Boolean	Looks if a certain entry is contained within the documention.
ContainsTopic ( String topic ) : System.Boolean	Looks if a certain topic is contained within the documention.
Create ( ParseContext context ) : Documentation	Creates a new documention instance from the given context.
Get ( String entry ) : HelpSection	Gets the HelpSection that belongs to the name of the given entry.
Overview ( ParseContext context ) : List	Gives an overview over the included functions and constants within the context.

Method	Description
AddTypeToTopics ( String name, String standardKind, Object type, List topics ) : void
Distance ( String s1, String s2, Int32 maxOffset ) : Int32
Documentation ( ParseContext _context ) : System
GetDescription ( MemberInfo element ) : String
GetExample ( ExampleAttribute attribute ) : HelpExample
GetLink ( MemberInfo element ) : String
GetLocalized ( String key ) : String
GetUsage ( String name, MethodInfo function ) : HelpFunctionUsage
ModifyValueType ( Type type ) : String

Finds the closest entry to the given entry.

public ClosestEntry ( String entry ) : String
entry	String	The (probably) mispelled entry's name.
return	String

Looks if a certain entry is contained within the documention.

public ContainsEntry ( String entry ) : System.Boolean
entry	String	The entry's name to look for.
return	System.Boolean

Looks if a certain topic is contained within the documention.

public ContainsTopic ( String topic ) : System.Boolean
topic	String	The topic to look for.
return	System.Boolean

Creates a new documention instance from the given context.

public static Create ( ParseContext context ) : Documentation
context	YAMP.ParseContext	The context to use.
return	Documentation

Gets the HelpSection that belongs to the name of the given entry.

public Get ( String entry ) : HelpSection
entry	String	The name of the entry to retrieve.
return	HelpSection

Gives an overview over the included functions and constants within the context.

public static Overview ( ParseContext context ) : List
context	YAMP.ParseContext	The context to investigate.
return	List