Added doc comments to Clause types

ThatRendle · ThatRendle · commit 0286b7bff7ba · 2011-07-20T13:07:42.000+01:00
diff --git a/Simple.Data/HavingClause.cs b/Simple.Data/HavingClause.cs
@@ -1,5 +1,10 @@
 namespace Simple.Data
 {
+    /// <summary>
+    /// Represents the "HAVING" clause (i.e. criteria over aggregations) of a <see cref="SimpleQuery"/>.
+    /// There may be zero, one or multiple instances of this type in <see cref="SimpleQuery.Clauses"/>;
+    /// for multiple instances, criteria should be combined with the AND operator.
+    /// </summary>
     public class HavingClause : SimpleQueryClauseBase
     {
         private readonly SimpleExpression _criteria;
diff --git a/Simple.Data/JoinClause.cs b/Simple.Data/JoinClause.cs
@@ -5,6 +5,10 @@
 
 namespace Simple.Data
 {
+    /// <summary>
+    /// Represents an explicit join in a <see cref="SimpleQuery"/>.
+    /// There may be zero, one or multiple instances of this type in <see cref="SimpleQuery.Clauses"/>.
+    /// </summary>
     public class JoinClause : SimpleQueryClauseBase
     {
         private readonly ObjectReference _table;
diff --git a/Simple.Data/OrderByClause.cs b/Simple.Data/OrderByClause.cs
@@ -1,5 +1,9 @@
 namespace Simple.Data
 {
+    /// <summary>
+    /// Represents the ordering clause of a <see cref="SimpleQuery"/>.
+    /// There may be zero, one or multiple instances of this type in <see cref="SimpleQuery.Clauses"/>; the order in that list should be treated as significant.
+    /// </summary>
     public class OrderByClause : SimpleQueryClauseBase
     {
         private readonly ObjectReference _reference;
diff --git a/Simple.Data/SelectClause.cs b/Simple.Data/SelectClause.cs
@@ -2,6 +2,10 @@
 
 namespace Simple.Data
 {
+    /// <summary>
+    /// Represents the set of columns/fields to be returned by a <see cref="SimpleQuery"/>.
+    /// There will be at most one instance of this type in <see cref="SimpleQuery.Clauses"/>.
+    /// </summary>
     public class SelectClause : SimpleQueryClauseBase
     {
         private readonly IEnumerable<SimpleReference> _columns;
diff --git a/Simple.Data/SimpleQueryClauseBase.cs b/Simple.Data/SimpleQueryClauseBase.cs
@@ -1,5 +1,8 @@
 namespace Simple.Data
 {
+    /// <summary>
+    /// Provides a base type for representing a clause within a <see cref="SimpleQuery"/>.
+    /// </summary>
     public abstract class SimpleQueryClauseBase
     {
         
diff --git a/Simple.Data/SkipClause.cs b/Simple.Data/SkipClause.cs
@@ -1,5 +1,9 @@
 namespace Simple.Data
 {
+    /// <summary>
+    /// Represents a number of records to skip in the results returned by a <see cref="SimpleQuery"/>.
+    /// There will be at most one instance of this type in <see cref="SimpleQuery.Clauses"/>.
+    /// </summary>
     public class SkipClause : SimpleQueryClauseBase
     {
         private readonly int _count;
diff --git a/Simple.Data/TakeClause.cs b/Simple.Data/TakeClause.cs
@@ -1,5 +1,9 @@
 namespace Simple.Data
 {
+    /// <summary>
+    /// Represents a number of records to take from the results returned by a <see cref="SimpleQuery"/>.
+    /// There will be at most one instance of this type in <see cref="SimpleQuery.Clauses"/>.
+    /// </summary>
     public class TakeClause : SimpleQueryClauseBase
     {
         private readonly int _count;
diff --git a/Simple.Data/WhereClause.cs b/Simple.Data/WhereClause.cs
@@ -1,5 +1,10 @@
 namespace Simple.Data
 {
+    /// <summary>
+    /// Represents the filtering criteria for a <see cref="SimpleQuery"/>.
+    /// There may be zero, one or multiple instances of this type in <see cref="SimpleQuery.Clauses"/>;
+    /// for multiple instances, criteria should be combined with the AND operator.
+    /// </summary>
     public class WhereClause : SimpleQueryClauseBase
     {
         private readonly SimpleExpression _criteria;

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,10 @@`
`1`	`1`	`namespace Simple.Data`
`2`	`2`	`{`
	`3`	`+ /// <summary>`
	`4`	`+ /// Represents the "HAVING" clause (i.e. criteria over aggregations) of a <see cref="SimpleQuery"/>.`
	`5`	`+ /// There may be zero, one or multiple instances of this type in <see cref="SimpleQuery.Clauses"/>;`
	`6`	`+ /// for multiple instances, criteria should be combined with the AND operator.`
	`7`	`+ /// </summary>`
`3`	`8`	`public class HavingClause : SimpleQueryClauseBase`
`4`	`9`	`{`
`5`	`10`	`private readonly SimpleExpression _criteria;`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,10 @@`
`5`	`5`
`6`	`6`	`namespace Simple.Data`
`7`	`7`	`{`
	`8`	`+ /// <summary>`
	`9`	`+ /// Represents an explicit join in a <see cref="SimpleQuery"/>.`
	`10`	`+ /// There may be zero, one or multiple instances of this type in <see cref="SimpleQuery.Clauses"/>.`
	`11`	`+ /// </summary>`
`8`	`12`	`public class JoinClause : SimpleQueryClauseBase`
`9`	`13`	`{`
`10`	`14`	`private readonly ObjectReference _table;`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,9 @@`
`1`	`1`	`namespace Simple.Data`
`2`	`2`	`{`
	`3`	`+ /// <summary>`
	`4`	`+ /// Represents the ordering clause of a <see cref="SimpleQuery"/>.`
	`5`	`+ /// There may be zero, one or multiple instances of this type in <see cref="SimpleQuery.Clauses"/>; the order in that list should be treated as significant.`
	`6`	`+ /// </summary>`
`3`	`7`	`public class OrderByClause : SimpleQueryClauseBase`
`4`	`8`	`{`
`5`	`9`	`private readonly ObjectReference _reference;`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,10 @@`
`2`	`2`
`3`	`3`	`namespace Simple.Data`
`4`	`4`	`{`
	`5`	`+ /// <summary>`
	`6`	`+ /// Represents the set of columns/fields to be returned by a <see cref="SimpleQuery"/>.`
	`7`	`+ /// There will be at most one instance of this type in <see cref="SimpleQuery.Clauses"/>.`
	`8`	`+ /// </summary>`
`5`	`9`	`public class SelectClause : SimpleQueryClauseBase`
`6`	`10`	`{`
`7`	`11`	`private readonly IEnumerable<SimpleReference> _columns;`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`namespace Simple.Data`
`2`	`2`	`{`
	`3`	`+ /// <summary>`
	`4`	`+ /// Provides a base type for representing a clause within a <see cref="SimpleQuery"/>.`
	`5`	`+ /// </summary>`
`3`	`6`	`public abstract class SimpleQueryClauseBase`
`4`	`7`	`{`
`5`	`8`