jasder
/
antlr
1
0
Fork 1
Code Issues Pull Requests Releases 1 Wiki Activity

Fix XML documentation warnings

This commit is contained in:
Sam Harwell 2013-04-17 21:42:17 -05:00
parent d01a221a6f
commit 6e198f8e0e
15 changed files with 33 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
runtime/CSharp/Antlr4.Runtime/Atn/ATNConfigSet.cs
View File

@ -55,7 +55,7 @@ namespace Antlr4.Runtime.Atn
/// added to this map stays, and the remaining configs are placed in
/// <see cref="unmerged">unmerged</see>
/// .
/// <p>
/// <p/>
/// This map is only used for optimizing the process of adding configs to the set,
/// and is
/// <code>null</code>
@ -70,7 +70,7 @@ namespace Antlr4.Runtime.Atn
/// but have a colliding key. This
/// occurs when two configs in the set have the same state and alternative but
/// different semantic contexts.
/// <p>
/// <p/>
/// This list is only used for optimizing the process of adding configs to the set,
/// and is
/// <code>null</code>
@ -100,7 +100,7 @@ namespace Antlr4.Runtime.Atn
/// </see>
/// from pursuing the global FOLLOW when a
/// rule stop state is reached with an empty prediction context.
/// <p>
/// <p/>
/// Note:
/// <code>outermostConfigSet</code>
/// and

4
runtime/CSharp/Antlr4.Runtime/Atn/LL1Analyzer.cs
View File

@ -102,13 +102,13 @@ namespace Antlr4.Runtime.Atn
/// is
/// <code>PredictionContext#EMPTY_LOCAL</code>
/// ,
/// <see cref="Antlr4.Runtime.IToken.Epsilon">EPSILON</see>
/// <see cref="Antlr4.Runtime.TokenConstants.Epsilon">EPSILON</see>
/// is in set if we can reach end of rule. If
/// <code>ctx</code>
/// is
/// <see cref="PredictionContext.EmptyFull">PredictionContext.EmptyFull</see>
/// ,
/// <see cref="Antlr4.Runtime.IIntStream.Eof">EOF</see>
/// <see cref="Antlr4.Runtime.IntStreamConstants.Eof">EOF</see>
/// is in set
/// if we can reach end of rule.
/// </summary>

2
runtime/CSharp/Antlr4.Runtime/Atn/ParserATNSimulator.cs
View File

@ -245,7 +245,7 @@ namespace Antlr4.Runtime.Atn
/// are suppressed. The default is
/// <code>false</code>
/// .
/// <p>
/// <p/>
/// When messages about ambiguous alternatives are not required, setting this
/// to
/// <code>false</code>

6
runtime/CSharp/Antlr4.Runtime/Atn/PredictionMode.cs
View File

@ -359,9 +359,9 @@ namespace Antlr4.Runtime.Atn
/// and singleton subsets with
/// non-conflicting configurations. Two configurations conflict if they have
/// identical
/// <see cref="ATNConfig#state">ATNConfig#state</see>
/// <see cref="ATNConfig.state">ATNConfig#state</see>
/// and
/// <see cref="ATNConfig#context">ATNConfig#context</see>
/// <see cref="ATNConfig.context">ATNConfig#context</see>
/// values
/// but different
/// <see cref="ATNConfig.Alt()">ATNConfig.Alt()</see>
@ -857,7 +857,7 @@ namespace Antlr4.Runtime.Atn
/// :
/// <pre>
/// map[c.
/// <see cref="ATNConfig#state">state</see>
/// <see cref="ATNConfig.state">state</see>
/// ] U= c.
/// <see cref="ATNConfig.Alt()">getAlt()</see>
/// </pre>

2
runtime/CSharp/Antlr4.Runtime/Atn/SemanticContext.cs
View File

@ -45,7 +45,7 @@ namespace Antlr4.Runtime.Atn
/// A tree structure used to record the semantic context in which
/// an ATN configuration is valid. It's either a single predicate,
/// a conjunction
/// <code>p1&&p2</code>
/// <code>p1&amp;&amp;p2</code>
/// , or a sum of products
/// <code>p1||p2</code>
/// .

2
runtime/CSharp/Antlr4.Runtime/BailErrorStrategy.cs
View File

@ -37,7 +37,7 @@ namespace Antlr4.Runtime
/// <remarks>
/// Bail out of parser at first syntax error. Do this to use it:
/// <p/>
/// <code>myparser.setErrorHandler(new BailErrorStrategy<Token>());</code>
/// <code>myparser.setErrorHandler(new BailErrorStrategy&lt;Token&gt;());</code>
/// </remarks>
public class BailErrorStrategy : DefaultErrorStrategy
{

4
runtime/CSharp/Antlr4.Runtime/BufferedTokenStream.cs
View File

@ -48,9 +48,9 @@ namespace Antlr4.Runtime
/// inside/output templates. E.g.,
/// <code></code>
/// &lt;names:
/// hi, <it>}&gt;} has to parse names
/// hi, &lt;it&gt;}&gt;} has to parse names
/// as part of an expression but
/// <code>"hi, <it>"</code>
/// <code>"hi, &lt;it&gt;"</code>
/// as a nested template.
/// You can't use this stream if you pass whitespace or other off-channel
/// tokens to the parser. The stream can't ignore off-channel tokens.

5
runtime/CSharp/Antlr4.Runtime/Dfa/DFA.cs
View File

@ -28,6 +28,7 @@
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
using System.Collections.Concurrent;
using System.Collections.Generic;
using Antlr4.Runtime.Atn;
using Antlr4.Runtime.Dfa;
using Antlr4.Runtime.Misc;
@ -41,11 +42,11 @@ namespace Antlr4.Runtime.Dfa
/// <summary>A set of all DFA states.</summary>
/// <remarks>
/// A set of all DFA states. Use
/// <see cref="System.Collections.IDictionary{K, V}">System.Collections.IDictionary&lt;K, V&gt;
/// <see cref="System.Collections.Generic.IDictionary{TKey, TValue}">IDictionary&lt;TKey, TValue&gt;
/// </see>
/// so we can get old state back
/// (
/// <see cref="Sharpen.ISet{E}">Sharpen.ISet&lt;E&gt;</see>
/// <see cref="HashSet{T}">HashSet&lt;T&gt;</see>
/// only allows you to see if it's there).
/// </remarks>
[NotNull]

12
runtime/CSharp/Antlr4.Runtime/IIntStream.cs
View File

@ -89,7 +89,7 @@ namespace Antlr4.Runtime
/// if an attempt is made to consume the the
/// end of the stream (i.e. if
/// <code>LA(1)==</code>
/// <see cref="Eof">EOF</see>
/// <see cref="IntStreamConstants.Eof">EOF</see>
/// before calling
/// <code>consume</code>
/// ).
@ -142,7 +142,7 @@ namespace Antlr4.Runtime
/// <code>i</code>
/// represents a position at or beyond the end of the stream,
/// this method returns
/// <see cref="Eof">Eof</see>
/// <see cref="IntStreamConstants.Eof">Eof</see>
/// .
/// <p/>
/// The return value is unspecified if
@ -295,7 +295,7 @@ namespace Antlr4.Runtime
/// <li>
/// <code>LA(1)</code>
/// returns
/// <see cref="Eof">Eof</see>
/// <see cref="IntStreamConstants.Eof">Eof</see>
/// </li>
/// </ul>
/// This operation is guaranteed to not throw an exception if
@ -342,7 +342,7 @@ namespace Antlr4.Runtime
/// Gets the name of the underlying symbol source. This method returns a
/// non-null, non-empty string. If such a name is not known, this method
/// returns
/// <see cref="UnknownSourceName">UnknownSourceName</see>
/// <see cref="IntStreamConstants.UnknownSourceName">UnknownSourceName</see>
/// .
/// </remarks>
string SourceName
@ -355,7 +355,7 @@ namespace Antlr4.Runtime
{
/// <summary>
/// The value returned by
/// <see cref="La(int)">LA()</see>
/// <see cref="IIntStream.La(int)">LA()</see>
/// when the end of the stream is
/// reached.
/// </summary>
@ -363,7 +363,7 @@ namespace Antlr4.Runtime
/// <summary>
/// The value returned by
/// <see cref="SourceName()">SourceName()</see>
/// <see cref="IIntStream.SourceName()">SourceName()</see>
/// when the actual name of the
/// underlying source is not known.
/// </summary>

2
runtime/CSharp/Antlr4.Runtime/ITokenStream.cs
View File

@ -174,7 +174,7 @@ namespace Antlr4.Runtime
/// </see>
/// , but may be
/// optimized by the specific implementation.
/// </p>
/// <p/>
/// If
/// <code>ctx.getSourceInterval()</code>
/// does not return a valid interval of

4
runtime/CSharp/Antlr4.Runtime/Misc/IntervalSet.cs
View File

@ -314,9 +314,9 @@ namespace Antlr4.Runtime.Misc
return compl;
}
/// <summary>Compute this-other via this&~other.</summary>
/// <summary>Compute this-other via this&amp;~other.</summary>
/// <remarks>
/// Compute this-other via this&~other.
/// Compute this-other via this&amp;~other.
/// Return a new set containing all elements in this but not in other.
/// other is assumed to be a subset of this;
/// anything that is in other but not in this will be ignored.

6
runtime/CSharp/Antlr4.Runtime/Parser.cs
View File

@ -827,11 +827,11 @@ namespace Antlr4.Runtime
}
/// <summary>
/// Return List<String> of the rule names in your parser instance
/// Return List&lt;String&gt; of the rule names in your parser instance
/// leading up to a call to the current rule.
/// </summary>
/// <remarks>
/// Return List<String> of the rule names in your parser instance
/// Return List&lt;String&gt; of the rule names in your parser instance
/// leading up to a call to the current rule. You could override if
/// you want more details such as the file/line info of where
/// in the ATN a rule is invoked.
@ -908,7 +908,7 @@ namespace Antlr4.Runtime
/// <summary>A convenience method for use most often with template rewrites.</summary>
/// <remarks>
/// A convenience method for use most often with template rewrites.
/// Convert a List<Token> to List<String>
/// Convert a List&lt;Token&gt; to List&lt;String&gt;
/// </remarks>
public virtual IList<string> ToStrings<_T0>(IList<_T0> tokens) where _T0:IToken
{

2
runtime/CSharp/Antlr4.Runtime/RuleContext.cs
View File

@ -183,7 +183,7 @@ namespace Antlr4.Runtime
/// <remarks>
/// Return the combined text of all child nodes. This method only considers
/// tokens which have been added to the parse tree.
/// <p>
/// <p/>
/// Since tokens on hidden channels (e.g. whitespace or comments) are not
/// added to the parse trees, they will not appear in the output of this
/// method.

9
runtime/CSharp/Antlr4.Runtime/Tree/AbstractParseTreeVisitor`1.cs
View File

@ -39,7 +39,7 @@ namespace Antlr4.Runtime.Tree
/// <inheritDoc></inheritDoc>
/// <p/>
/// The default implementation calls
/// <see cref="IParseTree.Accept{T}(IParseTreeVisitor{Result})">IParseTree.Accept&lt;T&gt;(IParseTreeVisitor&lt;Result&gt;)
/// <see cref="IParseTree.Accept{T}(IParseTreeVisitor{T})">IParseTree.Accept&lt;T&gt;(IParseTreeVisitor&lt;Result&gt;)
/// </see>
/// on the
/// specified tree.
@ -56,15 +56,14 @@ namespace Antlr4.Runtime.Tree
/// <see cref="AbstractParseTreeVisitor{Result}.DefaultResult()">defaultResult()</see>
/// . Before visiting each child, it
/// calls
/// <see cref="AbstractParseTreeVisitor{Result}.ShouldVisitNextChild(IRuleNode, object)
/// ">shouldVisitNextChild</see>
/// <see cref="AbstractParseTreeVisitor{Result}.ShouldVisitNextChild(IRuleNode, Result)">shouldVisitNextChild</see>
/// ; if the result
/// is
/// <code>false</code>
/// no more children are visited and the current aggregate
/// result is returned. After visiting a child, the aggregate result is
/// updated by calling
/// <see cref="AbstractParseTreeVisitor{Result}.AggregateResult(object, object)">aggregateResult
/// <see cref="AbstractParseTreeVisitor{Result}.AggregateResult(Result, Result)">aggregateResult
/// </see>
/// with the
/// previous aggregate result and the result of visiting the child.
@ -139,7 +138,7 @@ namespace Antlr4.Runtime.Tree
/// <remarks>
/// Aggregates the results of visiting multiple children of a node. After
/// either all children are visited or
/// <see cref="AbstractParseTreeVisitor{Result}.ShouldVisitNextChild(IRuleNode, object)
/// <see cref="AbstractParseTreeVisitor{Result}.ShouldVisitNextChild(IRuleNode, Result)
/// ">AbstractParseTreeVisitor&lt;Result&gt;.ShouldVisitNextChild(IRuleNode, object)
/// </see>
/// returns

1
runtime/CSharp/Antlr4.Runtime/Tree/IParseTreeVisitor`1.cs
View File

@ -43,7 +43,6 @@ namespace Antlr4.Runtime.Tree
/// .
/// </remarks>
/// <author>Sam Harwell</author>
/// <?></?>
#if NET_CF
public interface IParseTreeVisitor<Result>
#else