Skip to content

Commit

Permalink
docs: Add XML comments to parser
Browse files Browse the repository at this point in the history
  • Loading branch information
MrDave1999 committed Jan 15, 2024
1 parent d6a5360 commit f74cdcb
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions src/Parser/YeSqlParser.cs
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,23 @@ public YeSqlParser() { }
/// </summary>
/// <param name="source">The data source to parsing.</param>
/// <param name="sqlFileName">The name of the SQL file that caused an error.</param>
/// <returns>A collection containing the tags with their associated SQL statements.</returns>
/// <exception cref="ArgumentNullException"><c>source</c> is <c>null</c>.</exception>
internal ISqlCollection Parse(string source, string sqlFileName)
{
_sqlFileName = sqlFileName;
return Parse(source, out _);
}

/// <inheritdoc cref="Parse(string, string)" />
/// <summary>
/// Start the parsing to extract the SQL statements from a data source.
/// </summary>
/// <remarks>
/// This method throws an exception when there is more than one parsing error.
/// </remarks>
/// <param name="source">The data source to parsing.</param>
/// <returns>A collection containing the tags with their associated SQL statements.</returns>
/// <exception cref="ArgumentNullException">
/// <c>source</c> is <c>null</c>.
/// </exception>
/// <exception cref="YeSqlParserException">
/// If the parser encounters one or more errors.
/// </exception>
Expand All @@ -66,9 +74,15 @@ public ISqlCollection ParseAndThrow(string source)
return sqlStatements;
}

/// <inheritdoc cref="Parse(string, string)" />
/// <summary>
/// Start the parsing to extract the SQL statements from a data source.
/// </summary>
/// <param name="source">The data source to parsing.</param>
/// <param name="validationResult">The validation result of the parsing process.</param>
/// <returns>A collection containing the tags with their associated SQL statements.</returns>
/// <exception cref="ArgumentNullException">
/// <c>source</c> is <c>null</c>.
/// </exception>
public ISqlCollection Parse(string source, out YeSqlValidationResult validationResult)
{
if(source is null)
Expand Down

0 comments on commit f74cdcb

Please sign in to comment.