Skip to content

Commit

Permalink
fix a few rogue xml doc comments missing line breaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Ste1io committed Oct 1, 2023
1 parent 3b943b5 commit 297055d
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 10 deletions.
12 changes: 9 additions & 3 deletions PetaPoco/Attributes/ResultColumnAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,17 @@ public enum IncludeInAutoSelect
}

/// <summary>
/// The ResultColumnAttribute class defines an attribute for POCO properties that should be used in <b>SQL queries only</b>, but ignored in UPDATE and INSERT operations.
/// The ResultColumnAttribute class defines an attribute for POCO properties that should be used in <b>SQL queries only</b>, but ignored
/// in UPDATE and INSERT operations.
/// </summary>
/// <remarks>
/// This attribute marks properties that are mapped to a column, but should not be involved in any mutating operations on the database. The property value is updated by queries from the database, but the database column it maps to will not be changed to reflect changes in this property.
/// <para>Use the <see cref="IncludeInAutoSelect"/> property to dictate whether the decorated property is included in operations using PetaPoco's AutoSelect feature (default is <see cref="IncludeInAutoSelect.No"/>). Auto-select queries are operations made using the "short form" syntax, without specifying the <c>SELECT [cols] FROM [table]</c> portion of the SQL statement. The inferred portion of the SQL statement is then automatically generated by PetaPoco based on generics or the called method's parameters.</para>
/// This attribute marks properties that are mapped to a column, but should not be involved in any mutating operations on the database.
/// The property value is updated by queries from the database, but the database column it maps to will not be changed to reflect
/// changes in this property.
/// <para>Use the <see cref="IncludeInAutoSelect"/> property to dictate whether the decorated property is included in operations using
/// PetaPoco's AutoSelect feature (default is <see cref="IncludeInAutoSelect.No"/>). Auto-select queries are operations made using the
/// "short form" syntax, without specifying the <c>SELECT [cols] FROM [table]</c> portion of the SQL statement. The inferred portion of
/// the SQL statement is then automatically generated by PetaPoco based on generics or the called method's parameters.</para>
/// </remarks>
[AttributeUsage(AttributeTargets.Property)]
public class ResultColumnAttribute : ColumnAttribute
Expand Down
3 changes: 2 additions & 1 deletion PetaPoco/IQuery.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
namespace PetaPoco
{
/// <summary>
/// Specifies a set of methods for executing SQL queries and returning the result set as lists, enumerables, single POCOs, multi-POCOs, or paged results.
/// Specifies a set of methods for executing SQL queries and returning the result set as lists, enumerables, single POCOs, multi-POCOs,
/// or paged results.
/// </summary>
public interface IQuery
{
Expand Down
20 changes: 14 additions & 6 deletions PetaPoco/Utilities/PagingHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ public class PagingHelper : IPagingHelper
/// Gets the regular expression used for matching the <c>SELECT</c> clause.
/// </summary>
/// <remarks>
/// <para>Beginning at the start of the string, this expression matches the keyword <c>SELECT</c> (inclusive), followed by one or more spaces, capturing everything in front of the word <c>FROM</c> (exclusive), accounting for special handling of nested parentheses, aggregate functions, etc.</para>
/// <para>Beginning at the start of the string, this expression matches the keyword <c>SELECT</c> (inclusive), followed by one or
/// more spaces, capturing everything in front of the word <c>FROM</c> (exclusive), accounting for special handling of nested
/// parentheses, aggregate functions, etc.</para>
/// <c><u>SELECT column1, column2</u> FROM tbl;</c><br/>
/// <c><u>SELECT SUM(column1) AS sum_col1, column2</u> FROM tbl;</c>
/// </remarks>
Expand All @@ -23,7 +25,8 @@ public class PagingHelper : IPagingHelper
/// Gets the regular expression used for matching the <c>DISTINCT</c> keyword.
/// </summary>
/// <remarks>
/// <para>Starting at the beginning of the string, this expression performs a simple match for the <c>DISTINCT</c> keyword in a SQL statement, followed by a space. Everything after is excluded.</para>
/// <para>Starting at the beginning of the string, this expression performs a simple match for the <c>DISTINCT</c> keyword in an SQL
/// statement, followed by a space. Everything after is excluded.</para>
/// <c>SELECT <u>DISTINCT</u> * FROM tbl;</c><br/>
/// <c>SELECT <u>DISTINCT</u> column1 FROM tbl;</c>
/// </remarks>
Expand All @@ -34,7 +37,9 @@ public class PagingHelper : IPagingHelper
/// Gets the regular expression used for matching the <c>ORDER BY</c> clause.
/// </summary>
/// <remarks>
/// <para>This expression matches the <c>ORDER BY</c> clause, followed by one or more column names as well as the accompanying optional sort order modifier keywords, <c>ASC</c> and <c>DESC</c>, for each (inclusive). <c>AS</c> alias declarations are excluded from the match.</para>
/// <para>This expression matches the <c>ORDER BY</c> clause, followed by one or more column names as well as the accompanying
/// optional sort order modifier keywords, <c>ASC</c> and <c>DESC</c>, for each (inclusive). <c>AS</c> alias declarations are
/// excluded from the match.</para>
/// <c>SELECT * FROM tbl <u>ORDER BY column1, column2 DESC;</u></c><br/>
/// <c>SELECT column1, column2 AS col2 <u>ORDER BY SUM(column1) ASC, col2;</u></c><br/>
/// </remarks>
Expand All @@ -46,7 +51,8 @@ public class PagingHelper : IPagingHelper
/// Gets the regular expression used for matching the <c>ORDER BY</c> keyword.
/// </summary>
/// <remarks>
/// <para>This expression performs a simple match for the <c>ORDER BY</c> keyword in a SQL statement, followed by a space. Everything after is excluded.</para>
/// <para>This expression performs a simple match for the <c>ORDER BY</c> keyword in a SQL statement, followed by a space.
/// Everything after is excluded.</para>
/// <c>SELECT * FROM tbl <u>ORDER BY</u> column1, column2 DESC;</c><br/>
/// <c>SELECT column1, column2 AS col2 <u>ORDER BY</u> SUM(column1) ASC, col2;</c>
/// </remarks>
Expand All @@ -57,7 +63,8 @@ public class PagingHelper : IPagingHelper
/// Gets the regular expression used for matching the <c>GROUP BY</c> clause.
/// </summary>
/// <remarks>
/// <para>Matches the <c>GROUP BY</c> clause, followed by one or more column names along with any aggregate functions or expressions. <c>AS</c> alias declarations are excluded from the match.</para>
/// <para>Matches the <c>GROUP BY</c> clause, followed by one or more column names along with any aggregate functions or
/// expressions. <c>AS</c> alias declarations are excluded from the match.</para>
/// <c>SELECT * FROM tbl <u>GROUP BY column1, column2</u>;</c><br/>
/// <c>SELECT column1, column2 <u>GROUP BY SUM(column1), column2</u>;</c><br/>
/// <c>SELECT column1 AS col1 FROM tbl <u>GROUP BY col1</u> ORDER BY col1;</c>
Expand All @@ -70,7 +77,8 @@ public class PagingHelper : IPagingHelper
/// Gets the regular expression used for matching the <c>GROUP BY</c> keyword.
/// </summary>
/// <remarks>
/// <para>This expression performs a simple match for the <c>GROUP BY</c> keyword in a SQL statement, followed by a space. Everything after is excluded.</para>
/// <para>This expression performs a simple match for the <c>GROUP BY</c> keyword in a SQL statement, followed by a space.
/// Everything after is excluded.</para>
/// <c>SELECT * FROM tbl <u>GROUP BY</u> column1, column2;</c><br/>
/// <c>SELECT column1, COUNT(column2) AS count_col2 FROM tbl <u>GROUP BY</u> column1 ORDER BY column1;</c>
/// </remarks>
Expand Down

0 comments on commit 297055d

Please sign in to comment.