|
|
<?xml version="1.0"?>
<doc>
<assembly>
<name>NDoc.Documenter.NLiterate</name>
</assembly>
<members>
<member name="T:NLiterate.CodeLanguage">
<summary>
Type of compilable language
</summary>
</member>
<member name="F:NLiterate.CodeLanguage.CS">
<summary>
C#
</summary>
</member>
<member name="F:NLiterate.CodeLanguage.VB">
<summary>
Visual Basic
</summary>
</member>
<member name="T:NLiterate.CodeSnippet">
<summary>
A tree of snippets
</summary>
</member>
<member name="M:NLiterate.CodeSnippet.#ctor(System.Xml.XmlElement,System.Xml.XmlElement)">
<summary>
Creates a new <see cref="T:NLiterate.CodeSnippet"/> instance.
</summary>
<param name="parentEl">Parent XML node that contains the child
code</param>
<param name="el">root code element</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="parentEl"/> or <paramref name="el"/>
is a null reference (Nothing in Visual Basic)
</exception>
</member>
<member name="M:NLiterate.CodeSnippet.GetSource">
<summary>
Gets the merge source code
</summary>
<returns>
Merge source code
</returns>
</member>
<member name="M:NLiterate.CodeSnippet.ToString">
<summary>
Converts to a string describing the snippet.
</summary>
<returns>
A <see cref="T:System.String"/> describing the <see cref="T:NLiterate.CodeSnippet"/>.
</returns>
</member>
<member name="M:NLiterate.CodeSnippet.SnippetCount(System.Xml.XmlDocument)">
<summary>
Gets the number of <see cref="T:NLiterate.CodeSnippet"/> in the document
</summary>
<remarks>
This count is computed using the following XPath expression:
<c>"//member/descendant::code[@compilable='true']"</c>
</remarks>
<param name="doc">XML document</param>
<returns>
Number of parts.
</returns>
</member>
<member name="M:NLiterate.CodeSnippet.FromXml(System.String,System.Xml.XmlDocument,NLiterate.CodeSnippetCollection)">
<summary>
Creates a <see cref="T:NLiterate.CodeSnippet"/> instance from xml.
</summary>
<param name="assemblyLocation">Name of the documented assembly</param>
<param name="doc">Xml document</param>
<param name="snippets">
Collection where the created snippets are stored
</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="assemblyLocation"/> or <paramref name="doc"/>
or <paramref name="snippets"/> is a null reference (Nothing in
Visual Basic).
</exception>
</member>
<member name="P:NLiterate.CodeSnippet.ParentNode">
<summary>
Gets the parent XML node
</summary>
<value>
Parent <see cref="T:System.Xml.XmlNode"/> instance.
</value>
</member>
<member name="P:NLiterate.CodeSnippet.References">
<summary>
Gets the additional assembly references collection
</summary>
<value>
The assembly reference collection.
</value>
</member>
<member name="P:NLiterate.CodeSnippet.Language">
<summary>
Gets or sets the target language.
</summary>
<value>
A value of <see cref="T:NLiterate.CodeLanguage"/> that identifies
the target .NET language.
</value>
</member>
<member name="P:NLiterate.CodeSnippet.EntryPoint">
<summary>
Gets or sets a value indicating if the snippet can be run (
if it has an entry point).
</summary>
<value>
true if the snippet has an entry point; otherwise false.
</value>
</member>
<member name="P:NLiterate.CodeSnippet.Results">
<summary>
Gets or sets the compilation results
</summary>
<value>
An instance of <see cref="T:System.CodeDom.Compiler.CompilerResults"/> describing
the compilation.
</value>
</member>
<member name="P:NLiterate.CodeSnippet.ExecutionResults">
<summary>
Gets or sets the execution results.
</summary>
<value>
An <see cref="P:NLiterate.CodeSnippet.ExecutionResults"/> instance if the code was run;
otherwise a null reference (Nothing in Visual Basic).
</value>
</member>
<member name="P:NLiterate.CodeSnippet.HiddenNamespace">
<summary>
Gets or set the <see cref="T:NLiterate.CodeSnippet"/> hidden namespace.
</summary>
<value>
Hidden namespace.
</value>
</member>
<member name="P:NLiterate.CodeSnippet.Root">
<summary>
Gets the root snippet node.
</summary>
<value>
Root <see cref="T:NLiterate.CodeSnippetNode"/> instance.
</value>
</member>
<member name="T:NLiterate.CodeSnippetCollection">
<summary>
A collection of elements of type <see cref="T:NLiterate.CodeSnippet"/>.
</summary>
</member>
<member name="M:NLiterate.CodeSnippetCollection.#ctor">
<summary>
Initializes a new empty instance of the <see cref="T:NLiterate.CodeSnippetCollection"/> class.
</summary>
</member>
<member name="M:NLiterate.CodeSnippetCollection.Add(NLiterate.CodeSnippet)">
<summary>
Adds an instance of type <see cref="T:NLiterate.CodeSnippet"/> to the end of this <see cref="T:NLiterate.CodeSnippetCollection"/> .
</summary>
<param name="value">
The <see cref="T:NLiterate.CodeSnippet"/> to be added to the end of this <see cref="T:NLiterate.CodeSnippetCollection"/> .
</param>
</member>
<member name="M:NLiterate.CodeSnippetCollection.Contains(NLiterate.CodeSnippet)">
<summary>
Determines whether a specfic <see cref="T:NLiterate.CodeSnippet"/> value is in this <see cref="T:NLiterate.CodeSnippetCollection"/>.
</summary>
<param name="value">
The <see cref="T:NLiterate.CodeSnippet"/> value to locate in this <see cref="T:NLiterate.CodeSnippetCollection"/>.
</param>
<returns>
true if value is found in this <see cref="T:NLiterate.CodeSnippetCollection"/>;
false otherwise.
</returns>
</member>
<member name="M:NLiterate.CodeSnippetCollection.IndexOf(NLiterate.CodeSnippet)">
<summary>
Return the zero-based index of the first occurrence of a specific value
in this <see cref="T:NLiterate.CodeSnippetCollection"/>
</summary>
<param name="value">
The <see cref="T:NLiterate.CodeSnippet"/> value to locate in the <see cref="T:NLiterate.CodeSnippetCollection"/>.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="M:NLiterate.CodeSnippetCollection.Insert(System.Int32,NLiterate.CodeSnippet)">
<summary>
Inserts an element into the <see cref="T:NLiterate.CodeSnippetCollection"/> at the specified index
</summary>
<param name="index">
The index at which the <see cref="T:NLiterate.CodeSnippet"/> is to be inserted.
</param>
<param name="value">
The <see cref="T:NLiterate.CodeSnippet"/> to insert.
</param>
</member>
<member name="M:NLiterate.CodeSnippetCollection.Remove(NLiterate.CodeSnippet)">
<summary>
Removes the first occurrence of a specific <see cref="T:NLiterate.CodeSnippet"/> from this <see cref="T:NLiterate.CodeSnippetCollection"/>.
</summary>
<param name="value">
The <see cref="T:NLiterate.CodeSnippet"/> value to remove from this <see cref="T:NLiterate.CodeSnippetCollection"/>.
</param>
</member>
<member name="M:NLiterate.CodeSnippetCollection.GetEnumerator">
<summary>
Returns an enumerator that can iterate through the elements of this <see cref="T:NLiterate.CodeSnippetCollection"/>.
</summary>
<returns>
An object that implements <see cref="T:System.Collections.IEnumerator"/>.
</returns>
</member>
<member name="P:NLiterate.CodeSnippetCollection.Item(System.Int32)">
<summary>
Gets or sets the <see cref="T:NLiterate.CodeSnippet"/> at the given index in this <see cref="T:NLiterate.CodeSnippetCollection"/>.
</summary>
</member>
<member name="T:NLiterate.CodeSnippetCollection.Enumerator">
<summary>
Type-specific enumeration class, used by CodeSnippetCollection.GetEnumerator.
</summary>
</member>
<member name="T:NLiterate.CodeSnippetCompiler">
<summary>
Helper class for the <see cref="T:NLiterate.CodeSnippet"/> compilation.
</summary>
</member>
<member name="M:NLiterate.CodeSnippetCompiler.OnBeginCompile(NLiterate.CodeSnippet)">
<summary>
Raises the <see cref="E:NLiterate.CodeSnippetCompiler.BeginCompile"/> event.
</summary>
<param name="snippet">
<see cref="T:NLiterate.CodeSnippet"/> instance to attach to the event.
</param>
</member>
<member name="M:NLiterate.CodeSnippetCompiler.OnCompileFailure(NLiterate.CodeSnippet)">
<summary>
Raises the <see cref="E:NLiterate.CodeSnippetCompiler.CompileFailure"/> event.
</summary>
<param name="snippet">
<see cref="T:NLiterate.CodeSnippet"/> instance to attach to the event.
</param>
</member>
<member name="M:NLiterate.CodeSnippetCompiler.OnCompileSuccess(NLiterate.CodeSnippet)">
<summary>
Raises the <see cref="E:NLiterate.CodeSnippetCompiler.CompileSuccess"/> event.
</summary>
<param name="snippet">
<see cref="T:NLiterate.CodeSnippet"/> instance to attach to the event.
</param>
</member>
<member name="M:NLiterate.CodeSnippetCompiler.OnBeginRun(NLiterate.CodeSnippet)">
<summary>
Raises the <see cref="E:NLiterate.CodeSnippetCompiler.BeginRun"/> event.
</summary>
<param name="snippet">
<see cref="T:NLiterate.CodeSnippet"/> instance to attach to the event.
</param>
</member>
<member name="M:NLiterate.CodeSnippetCompiler.Process(NLiterate.CodeSnippet)">
<summary>
Compiles and runs the snippet.
</summary>
<param name="snippet">
<see cref="T:NLiterate.CodeSnippet"/> instance to process.
</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="snippet"/> is a null reference (Nothing in Visual Basic)
</exception>
</member>
<member name="E:NLiterate.CodeSnippetCompiler.BeginCompile">
<summary>
Raised when compilation starts.
</summary>
</member>
<member name="E:NLiterate.CodeSnippetCompiler.CompileFailure">
<summary>
Raised when compilation is finished, with errors.
</summary>
</member>
<member name="E:NLiterate.CodeSnippetCompiler.CompileSuccess">
<summary>
Raised when compilation is finished, without errors.
</summary>
</member>
<member name="E:NLiterate.CodeSnippetCompiler.BeginRun">
<summary>
Raised when compilation starts.
</summary>
</member>
<member name="T:NLiterate.CodeSnippetEventArgs">
<summary>
Event data containing a <see cref="T:NLiterate.CodeSnippet"/>.
</summary>
</member>
<member name="M:NLiterate.CodeSnippetEventArgs.#ctor(NLiterate.CodeSnippet)">
<summary>
Initializes a new instance of the <see cref="T:NLiterate.CodeSnippetEventArgs"/>
class with a snippet.
</summary>
<param name="snippet">Snippet to attach to the class</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="snippet"/> is a null reference (Nothing in
Visual Basic)
</exception>
</member>
<member name="P:NLiterate.CodeSnippetEventArgs.Snippet">
<summary>
Gets the <see cref="T:NLiterate.CodeSnippet"/> instance attached to the class.
</summary>
<value>
The <see cref="T:NLiterate.CodeSnippet"/> instance attached.
</value>
</member>
<member name="T:NLiterate.CodeSnippetEventHandler">
<summary>
Delegate for <see cref="T:NLiterate.CodeSnippetEventArgs"/>.
</summary>
<param name="sender">
object that raised the event
</param>
<param name="e">
<see cref="T:NLiterate.CodeSnippetEventArgs"/> instance.
</param>
</member>
<member name="T:NLiterate.CodeSnippetNode">
<summary>
A snippet of code for literate documentation.
</summary>
<remarks>
<para>
</para>
</remarks>
</member>
<member name="M:NLiterate.CodeSnippetNode.#ctor(NLiterate.CodeSnippetNode,System.String,System.String,System.String)">
<summary>
Initializes a new <see cref="T:NLiterate.CodeSnippetNode"/>
</summary>
<param name="parent">Parent <see cref="T:NLiterate.CodeSnippetNode"/></param>
<param name="id">node id</param>
<param name="title">node title</param>
<param name="code">node source code</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="id"/> or
<paramref name="code"/> is a null reference (Nothing in
Visual Basic)
</exception>
</member>
<member name="M:NLiterate.CodeSnippetNode.GetMergedCode">
<summary>
Gets the <see cref="T:NLiterate.CodeSnippetNode"/> content where child snippet
have been merged in.
</summary>
<returns>
Merged code
</returns>
</member>
<member name="M:NLiterate.CodeSnippetNode.ToString">
<summary>
Converts the <see cref="T:NLiterate.CodeSnippetNode"/> to code
</summary>
<returns>
String representing the <see cref="T:NLiterate.CodeSnippetNode"/>.
</returns>
</member>
<member name="M:NLiterate.CodeSnippetNode.FromXml(NLiterate.CodeSnippetNode,System.Xml.XmlElement,System.Xml.XmlElement)">
<summary>
Creates from XML
</summary>
<param name="parent">parent node</param>
<param name="parentEl">parent xml node</param>
<param name="el">xml node</param>
<returns>
A new <see cref="T:NLiterate.CodeSnippetNode"/> instance
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="parentEl"/> or <paramref name="el"/>
is a null reference (Nothing in
Visual Basic)
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="el"/>.Name is not <c>"code"</c>.
</exception>
<exception cref="T:System.ArgumentException">
<c>el/@id</c> is missing.
</exception>
</member>
<member name="P:NLiterate.CodeSnippetNode.ParentNode">
<summary>
Gets the parent snippet of code
</summary>
<value>
Parent <see cref="T:NLiterate.CodeSnippetNode"/> instance
</value>
</member>
<member name="P:NLiterate.CodeSnippetNode.ChildNodes">
<summary>
Gets the referenced snippets of code nodes
</summary>
<value>
Collection of child <see cref="T:NLiterate.CodeSnippetNode"/> instance
</value>
</member>
<member name="P:NLiterate.CodeSnippetNode.ID">
<summary>
Gets the Code snippet ID
</summary>
<value>
The snippet ID
</value>
</member>
<member name="P:NLiterate.CodeSnippetNode.Title">
<summary>
Gets the <see cref="T:NLiterate.CodeSnippetNode"/> title
</summary>
<value>
<see cref="T:NLiterate.CodeSnippetNode"/> title
</value>
</member>
<member name="P:NLiterate.CodeSnippetNode.Code">
<summary>
Gets the raw code data of the <see cref="T:NLiterate.CodeSnippetNode"/>
</summary>
<value>
The row content of the <see cref="T:NLiterate.CodeSnippetNode"/>
</value>
</member>
<member name="T:NLiterate.CodeSnippetNodeCollection">
<summary>
A collection of elements of type <see cref="T:NLiterate.CodeSnippetNode"/>
</summary>
</member>
<member name="M:NLiterate.CodeSnippetNodeCollection.#ctor">
<summary>
Initializes a new empty instance of the <see cref="T:NLiterate.CodeSnippetNodeCollection"/> class.
</summary>
</member>
<member name="M:NLiterate.CodeSnippetNodeCollection.Add(NLiterate.CodeSnippetNode)">
<summary>
Adds an instance of type <see cref="T:NLiterate.CodeSnippetNode"/> to the end of this <see cref="T:NLiterate.CodeSnippetNodeCollection"/>.
</summary>
<param name="value">
The <see cref="T:NLiterate.CodeSnippetNode"/> to be added to the end of this <see cref="T:NLiterate.CodeSnippetNodeCollection"/>.
</param>
</member>
<member name="M:NLiterate.CodeSnippetNodeCollection.Contains(NLiterate.CodeSnippetNode)">
<summary>
Determines whether a specfic <see cref="T:NLiterate.CodeSnippetNode"/> value is in this <see cref="T:NLiterate.CodeSnippetNodeCollection"/>.
</summary>
<param name="value">
The <see cref="T:NLiterate.CodeSnippetNode"/> value to locate in this <see cref="T:NLiterate.CodeSnippetNodeCollection"/>.
</param>
<returns>
true if value is found in this <see cref="T:NLiterate.CodeSnippetNodeCollection"/>;
false otherwise.
</returns>
</member>
<member name="M:NLiterate.CodeSnippetNodeCollection.IndexOf(NLiterate.CodeSnippetNode)">
<summary>
Return the zero-based index of the first occurrence of a specific value
in this <see cref="T:NLiterate.CodeSnippetNodeCollection"/>
</summary>
<param name="value">
The <see cref="T:NLiterate.CodeSnippetNode"/> value to locate in the <see cref="T:NLiterate.CodeSnippetNodeCollection"/>.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="M:NLiterate.CodeSnippetNodeCollection.Insert(System.Int32,NLiterate.CodeSnippetNode)">
<summary>
Inserts an element into the <see cref="T:NLiterate.CodeSnippetNodeCollection"/> at the specified index
</summary>
<param name="index">
The index at which the <see cref="T:NLiterate.CodeSnippetNode"/> is to be inserted.
</param>
<param name="value">
The <see cref="T:NLiterate.CodeSnippetNode"/> to insert.
</param>
</member>
<member name="M:NLiterate.CodeSnippetNodeCollection.Remove(NLiterate.CodeSnippetNode)">
<summary>
Removes the first occurrence of a specific <see cref="T:NLiterate.CodeSnippetNode"/> from this <see cref="T:NLiterate.CodeSnippetNodeCollection"/>.
</summary>
<param name="value">
The <see cref="T:NLiterate.CodeSnippetNode"/> value to remove from this <see cref="T:NLiterate.CodeSnippetNodeCollection"/>.
</param>
</member>
<member name="M:NLiterate.CodeSnippetNodeCollection.GetEnumerator">
<summary>
Returns an enumerator that can iterate through the elements of this <see cref="T:NLiterate.CodeSnippetNodeCollection"/>.
</summary>
<returns>
An object that implements <see cref="T:System.Collections.IEnumerator"/>.
</returns>
</member>
<member name="P:NLiterate.CodeSnippetNodeCollection.Item(System.Int32)">
<summary>
Gets or sets the <see cref="T:NLiterate.CodeSnippetNode"/> at the given index in this <see cref="T:NLiterate.CodeSnippetNodeCollection"/>.
</summary>
</member>
<member name="T:NLiterate.CodeSnippetNodeCollection.Enumerator">
<summary>
Type-specific enumeration class, used by CodeSnippetNodeCollection.GetEnumerator.
</summary>
</member>
<member name="T:NLiterate.LiterateDocumenterConfig">
<summary>
<see cref="T:NLiterate.LiterateDocumenter"/> config.
</summary>
</member>
<member name="M:NLiterate.LiterateDocumenterConfig.#ctor">
<summary>
Initializes an instance of the class.
</summary>
</member>
<member name="P:NLiterate.LiterateDocumenterConfig.OutputFile">
<summary>
Gets or sets the output file name.
</summary>
<value>
Output file name
</value>
</member>
<member name="T:NLiterate.LiterateDocumenter">
<summary>
NDoc <see cref="T:NDoc.Core.IDocumenter"/> that applies literate programming
to comments.
</summary>
<remarks>
</remarks>
</member>
<member name="M:NLiterate.LiterateDocumenter.#ctor">
<summary>
Initializes a new instance of the class.
</summary>
</member>
<member name="M:NLiterate.LiterateDocumenter.Build(NDoc.Core.Project)">
<summary>
Builds the documentation.
</summary>
</member>
<member name="M:NLiterate.LiterateDocumenter.Clear">
<summary>
Resets the documenter to a clean state.
</summary>
</member>
<member name="P:NLiterate.LiterateDocumenter.DevelopmentStatus">
<summary>
Gets the development status (alpha, beta, stable) of this documenter.
</summary>
<value>
The development status (alpha, beta, stable) of this documenter.
</value>
</member>
<member name="P:NLiterate.LiterateDocumenter.MainOutputFile">
<summary>
Gets the documenter's main output file path.
</summary>
<value>
The Documenter's main output file path
</value>
</member>
<member name="T:NLiterate.ExecutionResults">
<summary>
Execution result class.
</summary>
</member>
<member name="M:NLiterate.ExecutionResults.#ctor">
<summary>
Initializes an empty execution result class.
</summary>
</member>
<member name="M:NLiterate.ExecutionResults.ToString">
<summary>
Converts instance to string
</summary>
<returns>
<see cref="T:System.String"/> representing the results.
</returns>
</member>
<member name="M:NLiterate.ExecutionResults.Execute(System.Reflection.MethodInfo)">
<summary>
Executes the method <paramref name="mi"/> and returns the result.
</summary>
<param name="mi">Method to execute</param>
<returns></returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="mi"/> is a null reference (Nothing in Visual Basic).
</exception>
</member>
<member name="M:NLiterate.ExecutionResults.NoEntryPoint">
<summary>
Execution results when the entry point method is not found.
</summary>
<returns></returns>
</member>
<member name="P:NLiterate.ExecutionResults.ConsoleOut">
<summary>
Gets or sets the console output stream
</summary>
<value>
Console.Out stream.
</value>
</member>
<member name="P:NLiterate.ExecutionResults.ConsoleError">
<summary>
Gets or sets the console error stream
</summary>
<value>
Console.Error stream
</value>
</member>
<member name="P:NLiterate.ExecutionResults.HasThrowed">
<summary>
Gets a value indicating if the execution has throwed.
</summary>
<value>
true if it has throwed, false otherwise
</value>
</member>
<member name="P:NLiterate.ExecutionResults.ThrowedException">
<summary>
Gets the exception throwed, a null reference if no exception
were throwed.
</summary>
<value>
Throwed <see cref="T:System.Exception"/>, a null reference (Nothing in
Visual Basic) if not throwed.
</value>
</member>
<member name="P:NLiterate.ExecutionResults.ReturnedValue">
<summary>
Gets the execution return value.
</summary>
<value>
integer returned by the entry point method.
</value>
</member>
</members>
</doc>
|
By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.
If a file you wish to view isn't highlighted, and is a text file (not binary), please
let us know and we'll add colourisation support for it.
Jonathan de Halleux is Civil Engineer in Applied Mathematics. He finished his PhD in 2004 in the rainy country of Belgium. After 2 years in the Common Language Runtime (i.e. .net), he is now working at Microsoft Research on Pex (http://research.microsoft.com/pex).
Submit an article or tip