Skip to content

Commit

Permalink
wrap doc comments at col 140
Browse files Browse the repository at this point in the history
consistent spacing before self-closing tags
  • Loading branch information
Ste1io committed Sep 30, 2023
1 parent 0e07b3d commit bfcdade
Show file tree
Hide file tree
Showing 52 changed files with 771 additions and 395 deletions.
23 changes: 15 additions & 8 deletions PetaPoco/Attributes/ColumnAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ namespace PetaPoco
/// The ColumnAttribute class defines an attribute for POCO properties that map to a database column.
/// </summary>
/// <remarks>
/// This attribute can be used to override the default mapped column name, provide hints to PetaPoco for how to treat DateTime and String columns, and further customize INSERT and UPDATE operations with the use of string templates.
/// This attribute can be used to override the default mapped column name, provide hints to PetaPoco for how to treat DateTime and
/// String columns, and further customize INSERT and UPDATE operations with the use of string templates.
/// </remarks>
[AttributeUsage(AttributeTargets.Property)]
public class ColumnAttribute : Attribute
Expand All @@ -18,28 +19,34 @@ public class ColumnAttribute : Attribute
public string Name { get; set; }

/// <summary>
/// Gets or sets whether the column is of type <see cref="AnsiString" /> (SQL DB data type <c>VARCHAR</c>).
/// Gets or sets whether the column is of type <see cref="AnsiString"/> (SQL DB data type <c>VARCHAR</c>).
/// </summary>
/// <remarks>
/// For use with <see cref="string"/> properties. This property is implicitly <see langword="true"/> for properties of type <see cref="AnsiString"/>.
/// For use with <see cref="string"/> properties. This property is implicitly <see langword="true"/> for properties of type <see
/// cref="AnsiString"/>.
/// </remarks>
public bool ForceToAnsiString { get; set; }

/// <summary>
/// Gets or sets whether the column is of type <see cref="DateTime2" />.
/// Gets or sets whether the column is of type <see cref="DateTime2"/>.
/// </summary>
/// <remarks>
/// For use with <see cref="DateTime"/> properties. This property is implicitly <see langword="true"/> for properties of type <see cref="DateTime2"/>.
/// For use with <see cref="DateTime"/> properties. This property is implicitly <see langword="true"/> for properties of type <see
/// cref="DateTime2"/>.
/// </remarks>
public bool ForceToDateTime2 { get; set; }

/// <summary>
/// Gets or sets whether the <see cref="System.Data.DbType.DateTime">DbType.DateTime</see> or <see cref="System.Data.DbType.DateTime2">DbType.DateTime2</see> values in this DB column are always UTC.
/// Gets or sets whether the <see cref="System.Data.DbType.DateTime">DbType.DateTime</see> or <see
/// cref="System.Data.DbType.DateTime2">DbType.DateTime2</see> values in this DB column are always UTC.
/// </summary>
/// <remarks>
/// No conversion is applied - the <see cref="DateTimeKind" /> of the POCO property's underlying <see cref="DateTime"/> value is simply set to correctly reflect the UTC timezone as an invariant.
/// No conversion is applied - the <see cref="DateTimeKind"/> of the POCO property's underlying <see cref="DateTime"/> value is
/// simply set to correctly reflect the UTC timezone as an invariant.
/// </remarks>
/// <value>If <see langword="true"/>, the underlying <see cref="DateTime"/>'s <see cref="DateTimeKind"/> property is set to <see cref="DateTimeKind.Utc">Utc</see>; otherwise, the default is used (<see cref="DateTimeKind.Unspecified">Unspecified</see>).</value>
/// <value>If <see langword="true"/>, the underlying <see cref="DateTime"/>'s <see cref="DateTimeKind"/> property is set to <see
/// cref="DateTimeKind.Utc">Utc</see>; otherwise, the default is used (<see
/// cref="DateTimeKind.Unspecified">Unspecified</see>).</value>
public bool ForceToUtc { get; set; }

/// <summary>
Expand Down
3 changes: 2 additions & 1 deletion PetaPoco/Attributes/ExplicitColumnsAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
namespace PetaPoco
{
/// <summary>
/// The ExplicitColumnsAttribute class defines an attribute for POCO classes specifying that only explicitly-marked properties should be mapped to columns in the database table.
/// The ExplicitColumnsAttribute class defines an attribute for POCO classes specifying that only explicitly-marked properties should be
/// mapped to columns in the database table.
/// </summary>
/// <remarks>
/// When using this attribute, any properties <i>not</i> decorated with one of the following attributes are ignored by the mapper:
Expand Down
6 changes: 4 additions & 2 deletions PetaPoco/Attributes/IgnoreAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ namespace PetaPoco
/// The IgnoreAttribute class defines an attribute for POCO properties that should be explicitly ignored by the mapper.
/// </summary>
/// <remarks>
/// Properties decorated with this attribute are completely ignored by PetaPoco, and do not participate in any database-related operations.
/// <para>If you find yourself using this attribute excessively, consider instead decorating your POCO class with the <see cref="ExplicitColumnsAttribute"/>, and then marking the properties you want mapped with their appropriate column attribute.</para>
/// Properties decorated with this attribute are completely ignored by PetaPoco, and do not participate in any database-related
/// operations.
/// <para>If you find yourself using this attribute excessively, consider instead decorating your POCO class with the <see
/// cref="ExplicitColumnsAttribute"/>, and then marking the properties you want mapped with their appropriate column attribute.</para>
/// </remarks>
/// <seealso cref="ExplicitColumnsAttribute"/>
[AttributeUsage(AttributeTargets.Property)]
Expand Down
4 changes: 3 additions & 1 deletion PetaPoco/Attributes/PrimaryKeyAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ namespace PetaPoco
/// The PrimaryKeyAttribute class defines an attribute for POCO properties that map to primary key columns in the database.
/// </summary>
/// <remarks>
/// The PrimaryKeyAttribute, when used in a POCO class, designates the decorated property as the primary key column in the database. It can also be used to override the default mapped column name for the primary key, mark the column as auto-incrementing, and optionally assign a sequence name for Oracle sequence columns.
/// The PrimaryKeyAttribute, when used in a POCO class, designates the decorated property as the primary key column in the database. It
/// can also be used to override the default mapped column name for the primary key, mark the column as auto-incrementing, and
/// optionally assign a sequence name for Oracle sequence columns.
/// </remarks>
[AttributeUsage(AttributeTargets.Class)]
public class PrimaryKeyAttribute : Attribute
Expand Down
3 changes: 2 additions & 1 deletion PetaPoco/Attributes/ResultColumnAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ public ResultColumnAttribute(IncludeInAutoSelect includeInAutoSelect)
}

/// <summary>
/// Initializes a new instance of the <see cref="ResultColumnAttribute"/> class with the specified column name and auto-select inclusion setting.
/// Initializes a new instance of the <see cref="ResultColumnAttribute"/> class with the specified column name and auto-select
/// inclusion setting.
/// </summary>
/// <param name="column">The name of the database column associated with this property.</param>
/// <param name="includeInAutoSelect">Specifies whether the property should be included in auto-select queries.</param>
Expand Down
6 changes: 4 additions & 2 deletions PetaPoco/Attributes/ValueConverterAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ namespace PetaPoco
/// The ValueConverterAttribute class provides a base class all ValueConverters must derive from and implement.
/// </summary>
/// <remarks>
/// ValueConverters are used to implement custom two-way conversions between your POCO property data type, and the mapped database column's data type. They are ideal for implementing a custom conversion without requiring any changes to the mapper.
/// <para>To provide a custom ValueConverter for a property, inherit from this class, and supply definitions for both conversion methods for your data type. Decorate the appropriate properties that require your ValueConverter with your derived class.</para>
/// ValueConverters are used to implement custom two-way conversions between your POCO property data type, and the mapped database
/// column's data type. They are ideal for implementing a custom conversion without requiring any changes to the mapper.
/// <para>To provide a custom ValueConverter for a property, inherit from this class, and supply definitions for both conversion methods
/// for your data type. Decorate the appropriate properties that require your ValueConverter with your derived class.</para>
/// </remarks>
[AttributeUsage(AttributeTargets.Property)]
public abstract class ValueConverterAttribute : Attribute
Expand Down
3 changes: 2 additions & 1 deletion PetaPoco/Core/AnsiString.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
/// Wraps a Unicode string that will be stored in a <c>VARCHAR</c> DB column as an <see cref="System.Data.DbType.AnsiString"/>.
/// </summary>
/// <remarks>
/// Using this type for a column-mapped POCO property is equivalent to decorating a <see cref="string"/> property with <see cref="ColumnAttribute.ForceToAnsiString"/>.
/// Using this type for a column-mapped POCO property is equivalent to decorating a <see cref="string"/> property with <see
/// cref="ColumnAttribute.ForceToAnsiString"/>.
/// </remarks>
public class AnsiString
{
Expand Down
38 changes: 26 additions & 12 deletions PetaPoco/Core/ColumnInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ namespace PetaPoco
/// The ColumnInfo class stores information about a column in the database.
/// </summary>
/// <remarks>
/// Typically ColumnInfo is automatically populated from the attributes on a POCO object and its properties. It can, however, also be returned from the <see cref="IMapper"/> interface allowing you to provide your own custom bindings between the DB and your POCOs.
/// Typically ColumnInfo is automatically populated from the attributes on a POCO object and its properties. It can, however, also be
/// returned from the <see cref="IMapper"/> interface allowing you to provide your own custom bindings between the DB and your POCOs.
/// </remarks>
/// <seealso cref="ColumnAttribute"/>
/// <seealso cref="Core.PocoColumn"/>
Expand All @@ -22,37 +23,47 @@ public class ColumnInfo
public string ColumnName { get; set; }

/// <summary>
/// Gets or sets whether this column represents a property that should be updated in queries that include a user-supplied <c>SELECT</c> statement, but ignored in queries generated by auto-select. Result columns are always ignored in <c>UPDATE</c> and <c>INSERT</c> operations.
/// Gets or sets whether this column represents a property that should be updated in queries that include a user-supplied
/// <c>SELECT</c> statement, but ignored in queries generated by auto-select. Result columns are always ignored in <c>UPDATE</c> and
/// <c>INSERT</c> operations.
/// </summary>
/// <value>If <see langword="true"/>, this property will be updated in SQL query operations containing a user-supplied <c>SELECT</c> statement, and ignored for all other database operations.</value>
/// <value>If <see langword="true"/>, this property will be updated in SQL query operations containing a user-supplied <c>SELECT</c>
/// statement, and ignored for all other database operations.</value>
/// <seealso cref="ResultColumnAttribute"/>
public bool ResultColumn { get; set; }

/// <summary>
/// Gets or sets whether this serves as a ResultColumn that is included with auto-select queries as well as queries containing user-supplied <c>SELECT</c> statements.
/// Gets or sets whether this serves as a ResultColumn that is included with auto-select queries as well as queries containing
/// user-supplied <c>SELECT</c> statements.
/// </summary>
/// <value>If <see langword="true"/>, this property will be updated in all SQL queries, but ignored for all other database operations such as INSERT and UPDATE.</value>
/// <value>If <see langword="true"/>, this property will be updated in all SQL queries, but ignored for all other database
/// operations such as INSERT and UPDATE.</value>
/// <seealso cref="ResultColumnAttribute.IncludeInAutoSelect"/>
public bool AutoSelectedResultColumn { get; set; }

/// <summary>
/// Gets or sets a value indicating whether the column's data type should be treated as <see cref="System.Data.DbType.AnsiString"/>.
/// </summary>
/// <remarks>
/// For use with <see cref="string"/> properties. This property is implicitly <see langword="true"/> for properties of type <see cref="AnsiString"/>.
/// For use with <see cref="string"/> properties. This property is implicitly <see langword="true"/> for properties of type <see
/// cref="AnsiString"/>.
/// </remarks>
/// <value>If <see langword="true"/>, the column's data type is assumed to be <see cref="System.Data.DbType.AnsiString">DbType.AnsiString</see> (equivalent to the DB data type <c>VARCHAR</c>).</value>
/// <value>If <see langword="true"/>, the column's data type is assumed to be <see
/// cref="System.Data.DbType.AnsiString">DbType.AnsiString</see> (equivalent to the DB data type <c>VARCHAR</c>).</value>
/// <seealso cref="AnsiString"/>
/// <seealso cref="ColumnAttribute.ForceToAnsiString"/>
public bool ForceToAnsiString { get; set; }

/// <summary>
/// Gets or sets a value indicating whether the column containing a DateTime data type should be treated as <see cref="System.Data.DbType.DateTime">DbType.DateTime</see>.
/// Gets or sets a value indicating whether the column containing a DateTime data type should be treated as <see
/// cref="System.Data.DbType.DateTime">DbType.DateTime</see>.
/// </summary>
/// <remarks>
/// For use with <see cref="DateTime"/> properties. This property is implicitly <see langword="true"/> for properties of type <see cref="DateTime2"/>.
/// For use with <see cref="DateTime"/> properties. This property is implicitly <see langword="true"/> for properties of type <see
/// cref="DateTime2"/>.
/// </remarks>
/// <value>If <see langword="true"/>, the column's data type is assumed to be <see cref="System.Data.DbType.DateTime">DbType.DateTime</see>.</value>
/// <value>If <see langword="true"/>, the column's data type is assumed to be <see
/// cref="System.Data.DbType.DateTime">DbType.DateTime</see>.</value>
/// <seealso cref="DateTime2"/>
/// <seealso cref="ColumnAttribute.ForceToDateTime2"/>
public bool ForceToDateTime2 { get; set; }
Expand All @@ -61,9 +72,12 @@ public class ColumnInfo
/// Gets or sets a value indicating whether the DateTime value of this column should be treated as UTC.
/// </summary>
/// <remarks>
/// For use with <see cref="DateTime"/> or <see cref="DateTime2"/> properties. No conversion is applied - the <see cref="DateTimeKind" /> of the POCO property's underlying <see cref="DateTime"/> value is simply set to correctly reflect the UTC timezone as an invariant.
/// For use with <see cref="DateTime"/> or <see cref="DateTime2"/> properties. No conversion is applied - the <see
/// cref="DateTimeKind"/> of the POCO property's underlying <see cref="DateTime"/> value is simply set to correctly reflect the UTC
/// timezone as an invariant.
/// </remarks>
/// <value>If <see langword="true"/>, the DateTime value is assumed to be in UTC. If <see langword="false"/>, the <see cref="DateTime.Kind"/> property will be assigned <see cref="DateTimeKind.Unspecified"/>.</value>
/// <value>If <see langword="true"/>, the DateTime value is assumed to be in UTC. If <see langword="false"/>, the <see
/// cref="DateTime.Kind"/> property will be assigned <see cref="DateTimeKind.Unspecified"/>.</value>
/// <seealso cref="DateTime2"/>
/// <seealso cref="ColumnAttribute.ForceToUtc"/>
public bool ForceToUtc { get; set; }
Expand Down
2 changes: 1 addition & 1 deletion PetaPoco/Core/ConventionMapper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace PetaPoco
/// The ConventionMapper class represents a configurable convention mapper.
/// </summary>
/// <remarks>
/// By default this mapper replaces the original <see cref="StandardMapper" /> without change, ensuring backwards compatibility.
/// By default this mapper replaces the original <see cref="StandardMapper"/> without change, ensuring backwards compatibility.
/// </remarks>
public class ConventionMapper : IMapper
{
Expand Down
Loading

0 comments on commit bfcdade

Please sign in to comment.