Skip to content

Commit 5ef500b

Browse files
author
Mike Doerfler
committed
Fixed all the <tt> comments to be <c> or <see cref=""> comments.
SVN: trunk@1573
1 parent dd87166 commit 5ef500b

13 files changed

+31
-28
lines changed

src/NHibernate/Collection/Bag.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ namespace NHibernate.Collection
88
{
99
/// <summary>
1010
/// An unordered, unkeyed collection that can contain the same element
11-
/// multiple times. The .net collections API, has no <tt>Bag</tt>.
12-
/// Most developers seem to use <tt>IList</tt>s to represent bag semantics,
11+
/// multiple times. The .net collections API, has no <c>Bag</c>.
12+
/// Most developers seem to use <see cref="IList" />s to represent bag semantics,
1313
/// so NHibernate follows this practice.
1414
/// </summary>
1515
[Serializable]

src/NHibernate/Collection/ICollectionPersister.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ namespace NHibernate.Collection
1717
/// Implements persistence of a collection instance while the instance is
1818
/// referenced in a particular role.</p>
1919
/// <p>
20-
/// This class is highly coupled to the <tt>PersistentCollection</tt>
20+
/// This class is highly coupled to the <see cref="PersistentCollection" />
2121
/// hierarchy, since double dispatch is used to load and update collection
2222
/// elements.</p>
2323
/// </summary>
@@ -70,7 +70,7 @@ public interface ICollectionPersister
7070
System.Type ElementClass { get; }
7171

7272
/// <summary>
73-
/// Read the key from a row of the <tt>IDataReader</tt>
73+
/// Read the key from a row of the <see cref="IDataReader" />
7474
/// </summary>
7575
/// <param name="rs"></param>
7676
/// <param name="session"></param>

src/NHibernate/Collection/IQueryableCollection.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public interface IQueryableCollection : IPropertyMapping, IJoinable, ICollection
3333
/// Get the persister of the element class, if this is a
3434
/// collection of entities (optional operation). Note that
3535
/// for a one-to-many association, the returned persister
36-
/// must be <tt>OuterJoinLoadable</tt>.
36+
/// must be <c>OuterJoinLoadable</c>.
3737
/// </summary>
3838
IClassPersister ElementPersister { get; }
3939

src/NHibernate/Engine/ISessionFactoryImplementor.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ public interface ISessionFactoryImplementor : IMapping, ISessionFactory
4848
bool IsOuterJoinedFetchEnabled { get; }
4949

5050
/// <summary>
51-
/// Are scrollable <tt>ResultSet</tt>s supported?
51+
/// Are scrollable <c>ResultSet</c>s supported?
5252
/// </summary>
5353
bool IsScrollableResultSetsEnabled { get; }
5454

5555
/// <summary>
56-
/// Get the database schema specified in <tt>hibernate.default_schema</tt>
56+
/// Get the database schema specified in <c>hibernate.default_schema</c>
5757
/// </summary>
5858
bool IsGetGeneratedKeysEnabled { get; }
5959

src/NHibernate/Engine/ISessionImplementor.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ public interface ISessionImplementor : ISession
103103
object InternalLoad( System.Type persistentClass, object id );
104104

105105
/// <summary>
106-
/// Load an instance without checking if it was deleted. If it does not exist, return <tt>null</tt>.
107-
/// Do not create a proxy (but do return any existing proxy).
106+
/// Load an instance without checking if it was deleted. If it does not exist,
107+
/// return <c>null</c>. Do not create a proxy (but do return any existing proxy).
108108
/// </summary>
109109
/// <param name="persistentClass"></param>
110110
/// <param name="id"></param>

src/NHibernate/Hql/QueryTranslator.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,8 @@ protected override ILoadable[ ] Persisters
194194
}
195195

196196
/// <summary>
197-
///Types of the return values of an <tt>iterate()</tt> style query.
198-
///Return an array of <tt>Type</tt>s.
197+
///Types of the return values of an <c>Enumerate()</c> style query.
198+
///Return an array of <see cref="IType" />s.
199199
/// </summary>
200200
public virtual IType[ ] ReturnTypes
201201
{

src/NHibernate/IQuery.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public interface IQuery
9696
/// Convenience method to return a single instance that matches
9797
/// the query, or null if the query returns no results.
9898
/// </summary>
99-
/// <returns>the single result or <tt>null</tt></returns>
99+
/// <returns>the single result or <c>null</c></returns>
100100
/// <exception cref="HibernateException">
101101
/// Thrown when there is more than one matching result.
102102
/// </exception>
@@ -122,9 +122,9 @@ public interface IQuery
122122

123123
/// <summary>
124124
/// Set the lockmode for the objects idententified by the
125-
/// given alias that appears in the <tt>FROM</tt> clause.
125+
/// given alias that appears in the <c>FROM</c> clause.
126126
/// </summary>
127-
/// <param name="alias">alias a query alias, or <tt>this</tt> for a collection filter</param>
127+
/// <param name="alias">alias a query alias, or <c>this</c> for a collection filter</param>
128128
/// <param name="lockMode"></param>
129129
void SetLockMode( string alias, LockMode lockMode );
130130

src/NHibernate/ISession.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -560,24 +560,24 @@ public interface ISession : IDisposable
560560
/// Create a new instance of <c>IQuery</c> for the given SQL string.
561561
/// </summary>
562562
/// <param name="sql">a query expressed in SQL</param>
563-
/// <param name="returnAlias">a table alias that appears inside <tt>{}</tt> in the SQL string</param>
563+
/// <param name="returnAlias">a table alias that appears inside <c>{}</c> in the SQL string</param>
564564
/// <param name="returnClass">the returned persistent class</param>
565565
/// <returns></returns>
566566
IQuery CreateSQLQuery( string sql, string returnAlias, System.Type returnClass );
567567

568568
/// <summary>
569-
/// Create a new instance of <tt>Query</tt> for the given SQL string.
569+
/// Create a new instance of <see cref="IQuery" /> for the given SQL string.
570570
/// </summary>
571571
/// <param name="sql">a query expressed in SQL</param>
572-
/// <param name="returnAliases">an array of table aliases that appear inside <tt>{}</tt> in the SQL string</param>
572+
/// <param name="returnAliases">an array of table aliases that appear inside <c>{}</c> in the SQL string</param>
573573
/// <param name="returnClasses">the returned persistent classes</param>
574574
/// <returns></returns>
575575
IQuery CreateSQLQuery( string sql, string[] returnAliases, System.Type[] returnClasses );
576576

577577
/// <summary>
578578
/// Completely clear the session. Evict all loaded instances and cancel all pending
579579
/// saves, updates and deletions. Do not close open enumerables or instances of
580-
/// <tt>ScrollableResults</tt>.
580+
/// <c>ScrollableResults</c>.
581581
/// </summary>
582582
void Clear();
583583
}

src/NHibernate/Loader/EntityLoader.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ namespace NHibernate.Loader
1111
/// Load an entity using outerjoin fetching to fetch associated entities.
1212
/// </summary>
1313
/// <remarks>
14-
/// The <tt>ClassPersister</tt> must implement <tt>ILoadable</tt>. For other entities,
15-
/// create a customized subclass of <tt>Loader</tt>.
14+
/// The <see cref="IClassPersister"/> must implement <see cref="ILoadable" />. For other entities,
15+
/// create a customized subclass of <see cref="Loader" />.
1616
/// </remarks>
1717
public class EntityLoader : AbstractEntityLoader, IUniqueEntityLoader
1818
{
@@ -21,7 +21,7 @@ public class EntityLoader : AbstractEntityLoader, IUniqueEntityLoader
2121

2222
/// <summary>
2323
///
24-
/// </summary>C:\Devel\Sourceforge\NHibernate\nhibernate\src\NHibernate\Loader\EntityLoader.cs
24+
/// </summary>
2525
/// <param name="persister"></param>
2626
/// <param name="batchSize"></param>
2727
/// <param name="factory"></param>

src/NHibernate/Loader/Loader.cs

+6-3
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,17 @@ namespace NHibernate.Loader
1717
/// Abstract superclass of object loading (and querying) strategies.
1818
/// </summary>
1919
/// <remarks>
20+
/// <p>
2021
/// This class implements useful common funtionality that concrete loaders would delegate to.
2122
/// It is not intended that this functionality would be directly accessed by client code (Hence,
2223
/// all methods of this class are declared <c>protected</c> or <c>private</c>.) This class relies heavily upon the
23-
/// <tt>ILoadable</tt> interface, which is the contract between this class and
24-
/// <tt>ClassPersister</tt>s that may be loaded by it.<br/>
25-
/// <br/>
24+
/// <see cref="ILoadable" /> interface, which is the contract between this class and
25+
/// <see cref="IClassPersister" />s that may be loaded by it.
26+
/// </p>
27+
/// <p>
2628
/// The present implementation is able to load any number of columns of entities and at most
2729
/// one collection role per query.
30+
/// </p>
2831
/// </remarks>
2932
public abstract class Loader
3033
{

src/NHibernate/Loader/OuterJoinLoader.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -752,7 +752,7 @@ protected override ICollectionPersister CollectionPersister
752752
}
753753

754754
/// <summary>
755-
/// Generate a sequence of <tt>LEFT OUTER JOIN</tt> clauses for the given associations.
755+
/// Generate a sequence of <c>LEFT OUTER JOIN</c> clauses for the given associations.
756756
/// </summary>
757757
/// <param name="associations"></param>
758758
/// <returns></returns>

src/NHibernate/NonUniqueResultException.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
namespace NHibernate
66
{
77
/// <summary>
8-
/// Thrown when the application calls <tt>Query.uniqueResult()</tt> and
9-
/// the query returned more than one result. Unlike all other Hibernate
8+
/// Thrown when the application calls <see cref="IQuery.UniqueResult()">IQuery.UniqueResult()</see>
9+
/// and the query returned more than one result. Unlike all other NHibernate
1010
/// exceptions, this one is recoverable!
1111
/// </summary>
1212
[Serializable]

src/NHibernate/Type/DynamicComponentType.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
namespace NHibernate.Type
1010
{
1111
/// <summary>
12-
/// Handles "dynamic" components, represented as <tt>Map</tt>s
12+
/// Handles "dynamic" components, represented as <c>&lt;map&gt;</c>s
1313
/// </summary>
1414
public class DynamicComponentType : AbstractType, IAbstractComponentType
1515
{

0 commit comments

Comments
 (0)