wx.Doc.DocBases Class Reference

List of all members.

Public Types
enum	HtmlMode
Public Member Functions
	DocBases ()
MethodDoc	GetMethodDoc (MemberDescriptor m)
MethodDoc	GetMethodDoc (System.Reflection.MethodInfo m)
MethodDoc	GetMethodDoc (System.Reflection.ConstructorInfo m)
PropertyDoc	GetPropertyDoc (MemberDescriptor p)
PropertyDoc	GetPropertyDoc (System.Reflection.PropertyInfo pi)
TypeDoc	GetTypeDoc (TypeDescriptor t)
TypeDoc	GetTypeDoc (Type t)
bool	Load (System.Reflection.Assembly ass)
void	WriteHTML (System.IO.TextWriter destination, HtmlMode mode, RuntimeEnv env, object codeElementDescriptor)

---

Detailed Description

A collection of assembly doc bases.

---

Member Enumeration Documentation

enum wx::Doc::DocBases::HtmlMode

Modes for WriteHTML().

Enumerator:

NoHyperlinks	Do not produce hyperlinks.
HelpProtocolWithDoxygenReferences	Produce hyperlinks to classes in doxygen convention. Identify words referring to code fragments by Example: wx.Window or Window() both will be identified as references to the class wx.Window. This will produce a hyperlink of the form <a href="help:classwx_1_1Window.html">wx.Window</a>

---

Constructor & Destructor Documentation

wx.Doc.DocBases.DocBases

(

)

---

Member Function Documentation

MethodDoc wx.Doc.DocBases.GetMethodDoc

(

MemberDescriptor

m

)

Returns the first non-empty documentation of the designated method in one of the loaded assembly documentations.

Parameters:

m

Designates the method whose documentation is requested. If this is a MethodDescriptor, then this will also search for a documentation to MethodDescriptor.Generalized.

Returns:

See also:

MethodDescriptor

MethodDoc wx.Doc.DocBases.GetMethodDoc

(

System.Reflection.MethodInfo

m

)

Returns the first non-empty documentation of the designated method in one of the loaded assembly documentations.

Parameters:

m

Designates the method whose documentation is requested.

Returns:

MethodDoc wx.Doc.DocBases.GetMethodDoc

(

System.Reflection.ConstructorInfo

m

)

Returns the first non-empty documentation of the designated constructor in one of the loaded assembly documentations.

Parameters:

m

Designates the method whose documentation is requested.

Returns:

PropertyDoc wx.Doc.DocBases.GetPropertyDoc

(

MemberDescriptor

p

)

Returns the first non-empty documentation of the designated type in one of the loaded assembly documentations.

Parameters:

p

Designates the property whose documentation is requested.

Returns:

PropertyDoc wx.Doc.DocBases.GetPropertyDoc

(

System.Reflection.PropertyInfo

pi

)

Returns the first non-empty documentation of the designated type in one of the loaded assembly documentations.

Parameters:

p

Designates the property whose documentation is requested.

Returns:

TypeDoc wx.Doc.DocBases.GetTypeDoc

(

TypeDescriptor

t

)

Returns the first non-empty documentation of the designated type in one of the loaded assembly documentations.

Parameters:

t

The type whose documentation is requested

Returns:

TypeDoc wx.Doc.DocBases.GetTypeDoc

(

Type

t

)

Returns the first non-empty documentation of the designated type in one of the loaded assembly documentations.

Parameters:

t

The type whose documentation is requested

Returns:

bool wx.Doc.DocBases.Load

(

System.Reflection.Assembly

ass

)

This method will try to load documentation on the provided assembly if this documentation has not already been loaded. This method will load file only once.

Parameters:

ass

The assembly, whose documentation shall be loaded.

Returns:

True if the documentation has been loaded. False, if the documentation has already been a part of the document base.

void wx.Doc.DocBases.WriteHTML	(	System.IO.TextWriter	destination,
		HtmlMode	mode,
		RuntimeEnv	env,
		object	codeElementDescriptor
	)

Writes an HTML text on a code element that has been documented here,

Parameters:

	destination	The generated HTML will be appended to this stream.
	env	Runtime environment. This will be used to dereference method descriptors. This is optional.
	codeElementDescriptor	A TypeDescriptor, MemberDescriptor, System.Type, System.Reflection.MethodInfo, System.Reflection.ConstructorInfo, orSystem.Reflection.PropertyInfo designating either a type, a method, a proeperty, or a cosntructor whose documentation shall be printed.
	mode	Specifies the desired mode.

---