lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mhern...@apache.org
Subject [Lucene.Net] svn commit: r1172426 [2/9] - in /incubator/lucene.net/branches/Lucene.Net_4e: build/scripts/ packages/SHFB/ packages/SHFB/Colorizer/ packages/SHFB/SharedContent/ packages/SHFB/Templates/ packages/SHFB/Web/
Date Mon, 19 Sep 2011 05:09:10 GMT
Added: incubator/lucene.net/branches/Lucene.Net_4e/packages/SHFB/ColorizerLibrary.xml
URL: http://svn.apache.org/viewvc/incubator/lucene.net/branches/Lucene.Net_4e/packages/SHFB/ColorizerLibrary.xml?rev=1172426&view=auto
==============================================================================
--- incubator/lucene.net/branches/Lucene.Net_4e/packages/SHFB/ColorizerLibrary.xml (added)
+++ incubator/lucene.net/branches/Lucene.Net_4e/packages/SHFB/ColorizerLibrary.xml Mon Sep
19 05:09:06 2011
@@ -0,0 +1,454 @@
+<?xml version="1.0"?>
+<doc>
+    <assembly>
+        <name>ColorizerLibrary</name>
+    </assembly>
+    <members>
+        <member name="T:ColorizerLibrary.CodeColorizer">
+            <summary>
+            Code colorizer provides a flexible solution for colorizing code
+            </summary>
+            <remarks>Original Author: Jonathan de Halleux, dehalleux@pelikhan.com,
+            2003.
+            <p/>Modified by Eric Woodruff (Eric@EWoodruff.us) 11/2006. The original
+            Code Project article and code by Jonathan can be found at:
+            <a href="http://www.codeproject.com/csharp/highlightcs.asp">
+            http://www.codeproject.com/csharp/highlightcs.asp</a>.</remarks>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.#ctor">
+            <summary>
+            Default constructor
+            </summary>
+            <remarks>Unless specified via the properties, the default language
+            and style files will be retrieved from the application
+            configuration file on first use.</remarks>
+            <overloads>There are two overloads for the constructor.</overloads>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.#ctor(System.String,System.String)">
+            <summary>
+            Constructor
+            </summary>
+            <param name="languageSyntax">XML syntax file name</param>
+            <param name="languageStyle">XSL style file name</param>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.ToString">
+            <summary>
+            Converting to string
+            </summary>
+            <returns>Returns the syntax and style in a string</returns>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.Init">
+            <summary>
+            Load the language file and preprocess it. Also loads the XSL file.
+            </summary>
+            <remarks>Call this method to reload the language files and reset
+            the colorizer to its default state.</remarks>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.ProcessAndHighlightText(System.String)">
+            <summary>
+            Processes HTML and highlight code in
+            <b>&lt;code&gt;...&lt;/code&gt;</b> and
+            <b>&lt;pre&gt;...&lt;/pre&gt;</b> tags.
+            </summary>
+            <param name="htmlText">The HTML text to colorize</param>
+            <returns>HTML with colorized code blocks</returns>
+            <remarks>See highlight.xml for a list of available languages.</remarks>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.LoadDefaultConfigFiles">
+            <summary>
+            Loads the configuration from the App.config/Web.config and create a
+            CodeColorizer.
+            </summary>
+            <exception cref="T:System.InvalidOperationException">This is thrown if
the
+            configuration file could not be loaded, if the
+            <b>ColorizerLibrary/syntax</b> node is not found, or if the
+            <b>ColorizerLibrary/style</b> node is not found.</exception>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.StripLeadingWhitespace(System.String,System.Int32)">
+            <summary>
+            This is used to strip a common amount of leading whitespace on all
+            lines of code in the block to colorize and to convert tabs to a
+            consistent number of spaces.
+            </summary>
+            <param name="text">The text containing the lines to clean up.</param>
+            <param name="tabSize">The number of spaces to which tab characters
+            are converted.</param>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.NumberAndOutline(System.String)">
+            <summary>
+            This is used to number lines and/or add collapsible sections for
+            #region and #if/#else/#endif blocks based on the current settings.
+            </summary>
+            <param name="text">The text containing the lines to modify.</param>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.BuildKeywordRegExp">
+            <summary>
+            Build the keyword family regular expressions.
+            </summary>
+            <remarks>This method creates regular expression that match a whole
+            keyword family and adds it as a parameter "regexp" to the
+            keywordlist node.</remarks>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.BuildRuleRegExp(System.Xml.XmlNode,System.Xml.XmlNode)">
+            <summary>
+            This builds regular expressions out of the context node
+            </summary>
+            <param name="languageNode">The language node.</param>
+            <param name="contextNode">The context node.</param>
+            <remarks>This method creates regular expressions that match all the
+            context rules and adds it as a parameter "regexp" to the context
+            node.</remarks>
+            <returns>The regular expression string for the context node.</returns>
+            <exception cref="T:System.InvalidOperationException">This is thrown if
the
+            regular expression rule is missing the expression attribute, if the
+            keyword list could not be found, or if the keyword list family or
+            regular expression could not be found.</exception>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.BuildRules(System.Xml.XmlNode)">
+            <summary>
+            This precompiles regular expressions and search strings and
+            prepares rules attribute.
+            </summary>
+            <param name="languageNode">The context node</param>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.BuildSyntax">
+            <summary>
+            This prepares the syntax XML file for use.
+            </summary>
+            <exception cref="T:System.InvalidOperationException">This is thrown if
the
+            highlight node could not be found in the configuration file.
+            </exception>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.FindRule(System.Xml.XmlNode,System.Xml.XmlNode,System.String)">
+            <summary>
+            This is used to find the rule that triggered the match.
+            </summary>
+            <param name="languageNode">The language node.</param>
+            <param name="contextNode">The context node.</param>
+            <param name="matchText">The text that matched the context regular
+            expression</param>
+            <remarks>If the Regex finds a rule occurrence, this method is used
+            to find which rule has been triggered.</remarks>
+            <returns>The node that triggered the match or null if no node is
+            found.</returns>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.ApplyRules(System.Xml.XmlNode,System.Xml.XmlNode,System.String,System.Xml.XmlNode)">
+            <summary>
+            This is used to apply the context rules successively to the code
+            string that needs colorizing.
+            </summary>
+            <param name="languageNode">The language node.</param>
+            <param name="contextNode">The context node.</param>
+            <param name="code">The code block to parse and convert.</param>
+            <param name="parsedCodeNode">Parent node that will contain the
+            parsed code.</param>
+            <remarks>This method uses the pre-computed regular expressions of
+            the context rules, rule matching, etc.  The results are added to
+            the XML document in the parsedcodeNode.</remarks>
+            <exception cref="T:System.InvalidOperationException">This is thrown if
a
+            rule match cannot be found or if a matching context node cannot
+            be found.</exception>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.BuildHighlightTree(System.Xml.XmlNode,System.String,System.String)">
+            <summary>
+            Create and populate an xml document with the corresponding parsed
+            language tree for highlighting.
+            </summary>
+            <param name="languageNode">The language node to use for parsing the
+            code.</param> 
+            <param name="rootTag">Root tag (under parsed code) for the
+            generated xml tree.</param> 
+            <param name="code">The code to parse</param>
+            <returns>Returns an <seealso cref="T:System.Xml.XmlDocument"/> document
+            containing the parsed nodes.</returns>
+            <remarks>This method builds an XML tree containing context node.
+            Use an XSL file to render it.</remarks>
+            <exception cref="T:System.ArgumentException">This is thrown if the
+            language node does not contain any contexts or if there is no
+            default context node.</exception>
+            <exception cref="T:System.InvalidOperationException">This is thrown if
the
+            main node of the parsed code XML document cannot be created.
+            </exception>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.ReplaceByCode(System.Text.RegularExpressions.Match)">
+            <summary>
+            This method is used as the match evaluator for the main colorizer
+            regular expression</summary>
+            <param name="match">Full match</param>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.OnSeeTagFound(System.Text.RegularExpressions.Match)">
+            <summary>
+            Replace a see tag with a marker and store it in the list
+            </summary>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.OnMarkerFound(System.Text.RegularExpressions.Match)">
+            <summary>
+            Replace a see tag marker with the next entry from the saved list
+            of tags.
+            </summary>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.LanguageSyntaxFileName">
+            <summary>
+            The syntax file name
+            </summary>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.LanguageStyleFileName">
+            <summary>
+            The style file name
+            </summary>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.NumberLines">
+            <summary>
+            This is used to set or get whether or not lines will be
+            numbered in code blocks without a <b>numberLines</b> attribute.
+            </summary>
+            <value>The default is false</value>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.OutliningEnabled">
+            <summary>
+            This is used to set or get whether or not outlining of #region
+            and #if/#else#/endif blocks is enabled in blocks without an
+            <b>outlining</b> attribute.
+            </summary>
+            <value>The default is false.  Note that if enabled, space for the
+            outline markers will only be reserved if the code contains any
+            collapsible regions.</value>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.KeepSeeTags">
+            <summary>
+            This is used to set or get whether or not <c>&lt;see&gt;</c>
tags
+            are preserved within the code.
+            </summary>
+            <value>The default is false to treat them as part of the colorized
+            code.  If set to true, any <c>&lt;see&gt;</c> tags are preserved
so
+            that they may be processed as normal HTML tags.  This is useful when
+            using the code colorizer in conjunction with a documentation tool
+            such as the <see href="http://SHFB.CodePlex.com">Sandcastle
+            Help File Builder</see>.</value>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.UseDefaultTitle">
+            <summary>
+            This is used to set or get whether or not to use a default title
+            based on the language name if a title is not specified.
+            </summary>
+            <value>The default is true.  If set to false, no title will appear
+            if one is not specified.</value>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.TabSize">
+            <summary>
+            This is used to set or get the tab size override for the colorizer
+            for code blocks without a <b>tabSize</b> attribute and no tab size
+            defined in the syntax file for the selected language.
+            </summary>
+            <value>The default is eight.</value>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.CopyText">
+            <summary>
+            This is used to set or get the text for the Copy link
+            </summary>
+            <value>The default is "Copy".</value>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.CopyImageUrl">
+            <summary>
+            This is used to set or get the image URL for the Copy link.
+            </summary>
+            <value>The default is "CopyCode.gif".  A copy of this file with
+            the same name suffixed with "_h" should exist to use as the image
+            when the link is highlighted (i.e. CopyCode_h.gif).</value>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.FriendlyNames">
+            <summary>
+            This is used to return a dictionary that maps the language IDs to
+            friendly names.
+            </summary>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.AlternateIds">
+            <summary>
+            This is used to return a dictionary that maps the alternate IDs
+            to actual IDs present in the syntax file.
+            </summary>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.CollapsibleRegion.#ctor(System.Int32,System.Text.RegularExpressions.Match,System.Int32)">
+            <summary>
+            Constructor
+            </summary>
+            <param name="line">The line number</param>
+            <param name="match">The match</param>
+            <param name="nesting">The nesting level</param>
+        </member>
+        <member name="M:ColorizerLibrary.CodeColorizer.CollapsibleRegion.#ctor(System.Int32,System.Int32)">
+            <summary>
+            Constructor.  This version assumes it's an #endif
+            </summary>
+            <param name="line">The line number</param>
+            <param name="nesting">The nesting level</param>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.CollapsibleRegion.LineNumber">
+            <summary>
+            The line number on which the region part occurs
+            </summary>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.CollapsibleRegion.NestingLevel">
+            <summary>
+            This returns the nesting level for the entry
+            </summary>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.CollapsibleRegion.RegionType">
+            <summary>
+            The region type
+            </summary>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.CollapsibleRegion.Description">
+            <summary>
+            The description for the collapsed text
+            </summary>
+        </member>
+        <member name="P:ColorizerLibrary.CodeColorizer.CollapsibleRegion.IsStart">
+            <summary>
+            This returns true if this entry represents the start of a
+            region.
+            </summary>
+        </member>
+        <member name="T:ColorizerLibrary.RegexDictionary">
+            <summary>
+             Dictionary associating string to Regex
+            </summary>
+            <remarks>This implementation uses a
+            <see cref="T:System.Collections.Generic.Dictionary`2"/> to store the Regex
+            objects.</remarks>
+        </member>
+        <member name="M:ColorizerLibrary.RegexDictionary.#ctor">
+            <summary>
+            Default constructor.
+            </summary>
+        </member>
+        <member name="M:ColorizerLibrary.RegexDictionary.KeyName(System.Xml.XmlNode,System.Xml.XmlNode)">
+            <summary>
+            This returns the key name based on the IDs of the two specified
+            nodes.
+            </summary>
+            <param name="node1">The first node</param>
+            <param name="node2">The second node</param>
+            <overloads>There are two overloads for this method</overloads>
+        </member>
+        <member name="M:ColorizerLibrary.RegexDictionary.KeyName(System.Xml.XmlNode,System.Xml.XmlNode,System.Xml.XmlNode)">
+            <summary>
+            This returns the key name based on the IDs of the three specified
+            nodes.
+            </summary>
+            <param name="node1">The first node</param>
+            <param name="node2">The second node</param>
+            <param name="node3">The third node</param>
+        </member>
+        <member name="M:ColorizerLibrary.RegexDictionary.GetRegexOptions(System.Xml.XmlNode)">
+            <summary>
+            Retrieve the regular expression options from the language node
+            </summary>
+            <param name="languageNode">langue name</param>
+            <returns>RegexOptions enumeration combination</returns>
+        </member>
+        <member name="M:ColorizerLibrary.RegexDictionary.AddKey(System.Xml.XmlNode,System.Xml.XmlNode,System.String)">
+            <summary>
+            Add a regex depending on two nodes
+            </summary>
+            <param name="languageNode">The language node</param>
+            <param name="subNode">The sub-node</param>
+            <param name="sRegExp">The regular expression string</param>
+            <exception cref="T:System.ArgumentNullException">This is thrown if a node
+            parameter is null or the regular expression is null.</exception>
+            <exception cref="T:System.ArgumentException">This is thrown if a node
+            parameter does not have an 'id' attribute or if the regular
+            expression could not be created.</exception>
+            <overloads>There are two overloads for this method</overloads>
+        </member>
+        <member name="M:ColorizerLibrary.RegexDictionary.AddKey(System.Xml.XmlNode,System.Xml.XmlNode,System.Xml.XmlNode,System.String)">
+            <summary>
+            Add a regex depending on three nodes
+            </summary>
+            <param name="languageNode">The language node</param>
+            <param name="subNode">The first sub-node</param>
+            <param name="subNode2">The second sub-node</param>
+            <param name="sRegExp">The regular expression string</param>
+            <exception cref="T:System.ArgumentNullException">This is thrown if a node
+            parameter is null or the regular expression is null.</exception>
+            <exception cref="T:System.ArgumentException">This is thrown if a node
+            parameter does not have an 'id' attribute or if the regular
+            expression could not be created.</exception>
+        </member>
+        <member name="M:ColorizerLibrary.RegexDictionary.GetKey(System.Xml.XmlNode,System.Xml.XmlNode)">
+            <summary>
+            Retrieves the regular expression out of 2 nodes
+            </summary>
+            <param name="languageNode">The language node</param>
+            <param name="subNode">The sub-node</param>
+            <returns>The regular expression</returns>
+            <exception cref="T:System.ArgumentNullException">This is thrown if a node
+            parameter is null or the regular expression is null.</exception>
+            <exception cref="T:System.ArgumentException">This is thrown if a node
+            parameter does not have an 'id' attribute.</exception>
+        </member>
+        <member name="M:ColorizerLibrary.RegexDictionary.GetKey(System.Xml.XmlNode,System.Xml.XmlNode,System.Xml.XmlNode)">
+            <summary>
+            Retrieves the regular expression out of 3 nodes
+            </summary>
+            <param name="languageNode">The language node</param>
+            <param name="subNode">The first sub-node</param>
+            <param name="subNode2">The second sub-node</param>
+            <returns>The regular expression</returns>
+            <exception cref="T:System.ArgumentNullException">This is thrown if a node
+            parameter is null or the regular expression is null.</exception>
+            <exception cref="T:System.ArgumentException">This is thrown if a node
+            parameter does not have an 'id' attribute.</exception>
+        </member>
+        <member name="T:ColorizerLibrary.Controls.TextColorizerControl">
+            <summary>
+            A syntax colorizing control
+            </summary>
+            <remarks>Original Author: Jonathan de Halleux, dehalleux@pelikhan.com,
+            2003.
+            <p/>Modified by Eric Woodruff (Eric@EWoodruff.us) 11/2006. The original
+            Code Project article and code by Jonathan can be found at:
+            <a href="http://www.codeproject.com/csharp/highlightcs.asp">
+            http://www.codeproject.com/csharp/highlightcs.asp</a>.</remarks>
+        </member>
+        <member name="M:ColorizerLibrary.Controls.TextColorizerControl.Render(System.Web.UI.HtmlTextWriter)">
+            <summary>
+            Renders the code
+            </summary>
+            <remarks>You must specify a colorizing engine using SetSyntaxEngine
+            before calling this method</remarks>
+            <param name="writer">HTML writer</param>
+        </member>
+        <member name="P:ColorizerLibrary.Controls.TextColorizerControl.SyntaxEngine">
+            <summary>
+            The syntax engine does the job.
+            </summary>
+        </member>
+        <member name="P:ColorizerLibrary.Controls.TextColorizerControl.Text">
+            <summary>
+            Get or set the text to colorize
+            </summary>
+        </member>
+        <member name="T:ColorizerLibrary.XmlHelper">
+            <summary>
+            Some basic function helpers for xml creation.
+            </summary>
+        </member>
+        <member name="M:ColorizerLibrary.XmlHelper.XmlAddChildCDATAElem(System.Xml.XmlNode,System.String,System.String)">
+            <summary>adds a CDATA child elem</summary>
+            <param name="node">node to append child</param>
+            <param name="nodeName">new child node name</param>
+            <param name="cdata">CDATA value</param>
+            <exception>If could not create child node</exception>
+            <exception>If could not create CDATA node</exception>
+        </member>
+        <member name="M:ColorizerLibrary.XmlHelper.XmlSetAttribute(System.Xml.XmlNode,System.String,System.String)">
+            <summary>
+            Adds or updates an attribute in the node
+            <param name="node">node to modify</param>
+            <param name="name">Attribute name</param>
+            <param name="text">Attribute value</param>
+            </summary>
+        </member>
+    </members>
+</doc>

Added: incubator/lucene.net/branches/Lucene.Net_4e/packages/SHFB/SandcastleBuilder.Components.dll
URL: http://svn.apache.org/viewvc/incubator/lucene.net/branches/Lucene.Net_4e/packages/SHFB/SandcastleBuilder.Components.dll?rev=1172426&view=auto
==============================================================================
Files incubator/lucene.net/branches/Lucene.Net_4e/packages/SHFB/SandcastleBuilder.Components.dll
(added) and incubator/lucene.net/branches/Lucene.Net_4e/packages/SHFB/SandcastleBuilder.Components.dll
Mon Sep 19 05:09:06 2011 differ



Mime
View raw message