Menu
▾
▴
[Nhibernate-commit] SF.net SVN: nhibernate:[5185] trunk/nhibernate/src/NHibernate
|
From: <jul...@us...> - 2010-09-14 15:31:37
|
Revision: 5185
http://nhibernate.svn.sourceforge.net/nhibernate/?rev=5185&view=rev
Author: julian-maughan
Date: 2010-09-14 15:31:30 +0000 (Tue, 14 Sep 2010)
Log Message:
-----------
Tidied a XML comment blocks that were badly formed and/or causing compiler warnings.
Modified Paths:
--------------
trunk/nhibernate/src/NHibernate/Cfg/Loquacious/ITypeDefConfiguration.cs
trunk/nhibernate/src/NHibernate/Dialect/DB2Dialect.cs
trunk/nhibernate/src/NHibernate/Dialect/Dialect.cs
trunk/nhibernate/src/NHibernate/Dialect/MsSql2005Dialect.cs
trunk/nhibernate/src/NHibernate/Dialect/MySQLDialect.cs
trunk/nhibernate/src/NHibernate/Dialect/PostgreSQLDialect.cs
trunk/nhibernate/src/NHibernate/Hql/IQueryTranslatorFactory.cs
trunk/nhibernate/src/NHibernate/ICriteria.cs
trunk/nhibernate/src/NHibernate/ISession.cs
Modified: trunk/nhibernate/src/NHibernate/Cfg/Loquacious/ITypeDefConfiguration.cs
===================================================================
--- trunk/nhibernate/src/NHibernate/Cfg/Loquacious/ITypeDefConfiguration.cs 2010-09-14 13:37:52 UTC (rev 5184)
+++ trunk/nhibernate/src/NHibernate/Cfg/Loquacious/ITypeDefConfiguration.cs 2010-09-14 15:31:30 UTC (rev 5185)
@@ -3,7 +3,7 @@
/// <summary>
/// Properties of TypeDef configuration.
/// </summary>
- /// <seealso cref="ConfigurationExtensions.TypeDefinition{TDef}<>"/>
+ /// <seealso cref="ConfigurationExtensions.TypeDefinition{TDef}"/>
public interface ITypeDefConfigurationProperties
{
/// <summary>
@@ -19,7 +19,7 @@
/// <example>
/// As <paramref name="value"/> an anonimous object can be used:
/// <code>
- /// configure.TypeDefinition<TableHiLoGenerator>(c=>
+ /// configure.TypeDefinition<TableHiLoGenerator>(c=>
/// {
/// c.Alias = "HighLow";
/// c.Properties = new {max_lo = 99};
Modified: trunk/nhibernate/src/NHibernate/Dialect/DB2Dialect.cs
===================================================================
--- trunk/nhibernate/src/NHibernate/Dialect/DB2Dialect.cs 2010-09-14 13:37:52 UTC (rev 5184)
+++ trunk/nhibernate/src/NHibernate/Dialect/DB2Dialect.cs 2010-09-14 15:31:30 UTC (rev 5185)
@@ -205,13 +205,15 @@
get { return true; }
}
-
/// <summary>
/// Add a <c>LIMIT</c> clause to the given SQL <c>SELECT</c>
/// </summary>
/// <param name="querySqlString">A Query in the form of a SqlString.</param>
- /// <param name="hasOffset">Offset of the first row is not zero</param>
- /// <returns>A new SqlString that contains the <c>LIMIT</c> clause.</returns>
+ /// <param name="offset">Offset of the first row to be returned by the query (zero-based)</param>
+ /// <param name="limit">Maximum number of rows to be returned by the query</param>
+ /// <param name="offsetParameterIndex">Optionally, the Offset parameter index</param>
+ /// <param name="limitParameterIndex">Optionally, the Limit parameter index</param>
+ /// <returns>A new <see cref="SqlString"/> that contains the <c>LIMIT</c> clause.</returns>
public override SqlString GetLimitString(SqlString querySqlString, int offset, int limit, int? offsetParameterIndex, int? limitParameterIndex)
{
/*
Modified: trunk/nhibernate/src/NHibernate/Dialect/Dialect.cs
===================================================================
--- trunk/nhibernate/src/NHibernate/Dialect/Dialect.cs 2010-09-14 13:37:52 UTC (rev 5184)
+++ trunk/nhibernate/src/NHibernate/Dialect/Dialect.cs 2010-09-14 15:31:30 UTC (rev 5185)
@@ -1409,12 +1409,14 @@
/// <summary>
/// Add a <c>LIMIT</c> clause to the given SQL <c>SELECT</c>
- /// when the dialect supports variable limits (i.e., parameters for the limit constraints)
+ /// when the dialect supports variable limits (i.e. parameters for the limit constraints)
/// </summary>
- /// <param name="querySqlString">A Query in the form of a SqlString.</param>
+ /// <param name="querySqlString">The <see cref="SqlString"/> to base the limit query off.</param>
/// <param name="offset">Offset of the first row to be returned by the query (zero-based)</param>
/// <param name="limit">Maximum number of rows to be returned by the query</param>
- /// <returns>A new SqlString that contains the <c>LIMIT</c> clause.</returns>
+ /// <param name="offsetParameterIndex">Optionally, the Offset parameter index</param>
+ /// <param name="limitParameterIndex">Optionally, the Limit parameter index</param>
+ /// <returns>A new <see cref="SqlString"/> that contains the <c>LIMIT</c> clause.</returns>
public virtual SqlString GetLimitString(SqlString querySqlString, int offset, int limit, int? offsetParameterIndex, int? limitParameterIndex)
{
if (!SupportsVariableLimit)
Modified: trunk/nhibernate/src/NHibernate/Dialect/MsSql2005Dialect.cs
===================================================================
--- trunk/nhibernate/src/NHibernate/Dialect/MsSql2005Dialect.cs 2010-09-14 13:37:52 UTC (rev 5184)
+++ trunk/nhibernate/src/NHibernate/Dialect/MsSql2005Dialect.cs 2010-09-14 15:31:30 UTC (rev 5185)
@@ -21,7 +21,7 @@
/// <summary>
/// Add a <c>LIMIT</c> clause to the given SQL <c>SELECT</c>
/// </summary>
- /// <param name="querySqlString">The <see cref="SqlString"/> to base the limit query off of.</param>
+ /// <param name="querySqlString">The <see cref="SqlString"/> to base the limit query off.</param>
/// <param name="offset">Offset of the first row to be returned by the query (zero-based)</param>
/// <param name="limit">Maximum number of rows to be returned by the query</param>
/// <param name="offsetParameterIndex">Optionally, the Offset parameter index</param>
Modified: trunk/nhibernate/src/NHibernate/Dialect/MySQLDialect.cs
===================================================================
--- trunk/nhibernate/src/NHibernate/Dialect/MySQLDialect.cs 2010-09-14 13:37:52 UTC (rev 5184)
+++ trunk/nhibernate/src/NHibernate/Dialect/MySQLDialect.cs 2010-09-14 15:31:30 UTC (rev 5185)
@@ -181,11 +181,14 @@
}
/// <summary>
- ///
+ /// Add a <c>LIMIT</c> clause to the given SQL <c>SELECT</c>
/// </summary>
- /// <param name="querySqlString"></param>
- /// <param name="hasOffset"></param>
- /// <returns></returns>
+ /// <param name="querySqlString">The <see cref="SqlString"/> to base the limit query off.</param>
+ /// <param name="offset">Offset of the first row to be returned by the query (zero-based)</param>
+ /// <param name="limit">Maximum number of rows to be returned by the query</param>
+ /// <param name="offsetParameterIndex">Optionally, the Offset parameter index</param>
+ /// <param name="limitParameterIndex">Optionally, the Limit parameter index</param>
+ /// <returns>A new <see cref="SqlString"/> that contains the <c>LIMIT</c> clause.</returns>
public override SqlString GetLimitString(SqlString querySqlString, int offset, int limit, int? offsetParameterIndex, int? limitParameterIndex)
{
var pagingBuilder = new SqlStringBuilder();
Modified: trunk/nhibernate/src/NHibernate/Dialect/PostgreSQLDialect.cs
===================================================================
--- trunk/nhibernate/src/NHibernate/Dialect/PostgreSQLDialect.cs 2010-09-14 13:37:52 UTC (rev 5184)
+++ trunk/nhibernate/src/NHibernate/Dialect/PostgreSQLDialect.cs 2010-09-14 15:31:30 UTC (rev 5185)
@@ -128,11 +128,14 @@
}
/// <summary>
- ///
+ /// Add a <c>LIMIT</c> clause to the given SQL <c>SELECT</c>
/// </summary>
- /// <param name="querySqlString"></param>
- /// <param name="hasOffset">Offset of the first row to process in the result set is non-zero</param>
- /// <returns></returns>
+ /// <param name="querySqlString">The <see cref="SqlString"/> to base the limit query off.</param>
+ /// <param name="offset">Offset of the first row to be returned by the query (zero-based)</param>
+ /// <param name="limit">Maximum number of rows to be returned by the query</param>
+ /// <param name="offsetParameterIndex">Optionally, the Offset parameter index</param>
+ /// <param name="limitParameterIndex">Optionally, the Limit parameter index</param>
+ /// <returns>A new <see cref="SqlString"/> that contains the <c>LIMIT</c> clause.</returns>
public override SqlString GetLimitString(SqlString querySqlString, int offset, int limit, int? offsetParameterIndex, int? limitParameterIndex)
{
SqlStringBuilder pagingBuilder = new SqlStringBuilder();
Modified: trunk/nhibernate/src/NHibernate/Hql/IQueryTranslatorFactory.cs
===================================================================
--- trunk/nhibernate/src/NHibernate/Hql/IQueryTranslatorFactory.cs 2010-09-14 13:37:52 UTC (rev 5184)
+++ trunk/nhibernate/src/NHibernate/Hql/IQueryTranslatorFactory.cs 2010-09-14 15:31:30 UTC (rev 5185)
@@ -16,31 +16,35 @@
/// capable of translating an HQL query string.
/// </summary>
/// <param name="queryString">The query string to be translated</param>
+ /// <param name="collectionRole"></param>
+ /// <param name="shallow"></param>
/// <param name="filters">Currently enabled filters</param>
/// <param name="factory">The session factory</param>
/// <returns>An appropriate translator.</returns>
- IQueryTranslator[] CreateQueryTranslators(string queryString, string collectionRole, bool shallow, IDictionary<string, IFilter> filters, ISessionFactoryImplementor factory);
+ IQueryTranslator[] CreateQueryTranslators(string queryString, string collectionRole, bool shallow, IDictionary<string, IFilter> filters, ISessionFactoryImplementor factory);
}
- /// <summary>
- /// Facade for generation of <see cref="NHibernate.Hql.IQueryTranslator"/>
- /// and <see cref="NHibernate.Hql.IFilterTranslator"/> instances.
- /// </summary>
- public interface IQueryTranslatorFactory2 : IQueryTranslatorFactory
- {
- /// <summary>
- /// Construct a <see cref="NHibernate.Hql.IQueryTranslator"/> instance
- /// capable of translating a Linq expression.
- /// </summary>
- /// <param name="queryIdentifier">
- /// The query-identifier (used in <see cref="NHibernate.Stat.QueryStatistics"/> collection).
- /// This is typically the same as the queryString parameter except for the case of
- /// split polymorphic queries which result in multiple physical sql queries.
- /// </param>
- /// <param name="queryExpression">The query expression to be translated</param>
- /// <param name="filters">Currently enabled filters</param>
- /// <param name="factory">The session factory</param>
- /// <returns>An appropriate translator.</returns>
- IQueryTranslator[] CreateQueryTranslators(string queryIdentifier, IQueryExpression queryExpression, string collectionRole, bool shallow, IDictionary<string, IFilter> filters, ISessionFactoryImplementor factory);
- }
+ /// <summary>
+ /// Facade for generation of <see cref="NHibernate.Hql.IQueryTranslator"/>
+ /// and <see cref="NHibernate.Hql.IFilterTranslator"/> instances.
+ /// </summary>
+ public interface IQueryTranslatorFactory2 : IQueryTranslatorFactory
+ {
+ /// <summary>
+ /// Construct a <see cref="NHibernate.Hql.IQueryTranslator"/> instance
+ /// capable of translating a Linq expression.
+ /// </summary>
+ /// <param name="queryIdentifier">
+ /// The query-identifier (used in <see cref="NHibernate.Stat.QueryStatistics"/> collection).
+ /// This is typically the same as the queryString parameter except for the case of
+ /// split polymorphic queries which result in multiple physical sql queries.
+ /// </param>
+ /// <param name="queryExpression">The query expression to be translated</param>
+ /// <param name="collectionRole"></param>
+ /// <param name="shallow"></param>
+ /// <param name="filters">Currently enabled filters</param>
+ /// <param name="factory">The session factory</param>
+ /// <returns>An appropriate translator.</returns>
+ IQueryTranslator[] CreateQueryTranslators(string queryIdentifier, IQueryExpression queryExpression, string collectionRole, bool shallow, IDictionary<string, IFilter> filters, ISessionFactoryImplementor factory);
+ }
}
\ No newline at end of file
Modified: trunk/nhibernate/src/NHibernate/ICriteria.cs
===================================================================
--- trunk/nhibernate/src/NHibernate/ICriteria.cs 2010-09-14 13:37:52 UTC (rev 5184)
+++ trunk/nhibernate/src/NHibernate/ICriteria.cs 2010-09-14 15:31:30 UTC (rev 5185)
@@ -136,7 +136,7 @@
/// <param name="associationPath"></param>
/// <param name="alias"></param>
/// <param name="joinType">The type of join to use.</param>
- /// <param name="withClause"The criteria to be added to the join condition (ON clause)</param>
+ /// <param name="withClause">The criteria to be added to the join condition (ON clause)</param>
/// <returns>this (for method chaining)</returns>
ICriteria CreateAlias(string associationPath, string alias, JoinType joinType, ICriterion withClause);
@@ -182,7 +182,7 @@
/// <param name="associationPath">A dot-separated property path</param>
/// <param name="alias">The alias to assign to the joined association (for later reference).</param>
/// <param name="joinType">The type of join to use.</param>
- /// <param name="withClause"The criteria to be added to the join condition (ON clause)</param>
+ /// <param name="withClause">The criteria to be added to the join condition (ON clause)</param>
/// <returns>The created "sub criteria"</returns>
ICriteria CreateCriteria(string associationPath, string alias, JoinType joinType, ICriterion withClause);
Modified: trunk/nhibernate/src/NHibernate/ISession.cs
===================================================================
--- trunk/nhibernate/src/NHibernate/ISession.cs 2010-09-14 13:37:52 UTC (rev 5184)
+++ trunk/nhibernate/src/NHibernate/ISession.cs 2010-09-14 15:31:30 UTC (rev 5185)
@@ -666,7 +666,7 @@
/// <summary>
/// Create a new instance of <c>Query</c> for the given query expression
- /// <param name="queryExpression"/>A hibernate query expression</param>
+ /// <param name="queryExpression">A hibernate query expression</param>
/// <returns>The query</returns>
/// </summary>
IQuery CreateQuery(IQueryExpression queryExpression);
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
