From: Michael D. <mik...@us...> - 2004-09-10 21:40:07
|
Update of /cvsroot/nhibernate/nhibernate/src/NHibernate/Mapping In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8474/src/NHibernate/Mapping Modified Files: Property.cs RootClass.cs Log Message: Fixing some of the xmldoc problems. Index: Property.cs =================================================================== RCS file: /cvsroot/nhibernate/nhibernate/src/NHibernate/Mapping/Property.cs,v retrieving revision 1.8 retrieving revision 1.9 diff -C2 -d -r1.8 -r1.9 *** Property.cs 22 Aug 2004 06:22:13 -0000 1.8 --- Property.cs 10 Sep 2004 21:23:15 -0000 1.9 *************** *** 27,30 **** --- 27,33 ---- } + /// <summary> + /// Gets the number of columns this property uses in the db. + /// </summary> public int ColumnSpan { *************** *** 32,35 **** --- 35,41 ---- } + /// <summary> + /// Gets an <see cref="ICollection"/> of <see cref="Column"/>s. + /// </summary> public ICollection ColumnCollection { *************** *** 37,40 **** --- 43,49 ---- } + /// <summary> + /// Gets or Sets the name of the Property in the class. + /// </summary> public string Name { Index: RootClass.cs =================================================================== RCS file: /cvsroot/nhibernate/nhibernate/src/NHibernate/Mapping/RootClass.cs,v retrieving revision 1.9 retrieving revision 1.10 diff -C2 -d -r1.9 -r1.10 *** RootClass.cs 29 Apr 2004 16:36:55 -0000 1.9 --- RootClass.cs 10 Sep 2004 21:23:15 -0000 1.10 *************** *** 5,8 **** --- 5,86 ---- namespace NHibernate.Mapping { + /// <summary> + /// Declaration of a System.Type by using the <c><class></c> element. + /// </summary> + /// <remarks> + /// <p>The <c><class></c> element has the following attributes available:</p> + /// <list type="table"> + /// <listheader> + /// <term>Attribute</term> + /// <description>Possible Values</description> + /// </listheader> + /// <item> + /// <term>name</term> + /// <description>The fully qualified TypeName so it can be loaded by Reflection</description> + /// </item> + /// <item> + /// <term>table</term> + /// <description>The name of its database table.</description> + /// </item> + /// <item> + /// <term>discriminator-value</term> + /// <description> + /// (optional - defaults to the FullClassName) A value that distinguishes individual + /// subclasses, used for polymorphic behavior. + /// </description> + /// </item> + /// <item> + /// <term>mutable</term> + /// <description> + /// (optional - defaults to <c>true</c>) Specifies that instances of the class + /// are (not) mutable. + /// </description> + /// </item> + /// <item> + /// <term>schema</term> + /// <description>(optional) Override the schema name specified by the root <c><hibernate-mapping></c> element.</description> + /// </item> + /// <item> + /// <term>proxy</term> + /// <description> + /// (optional) Specifies an interface to use for lazy initializing proxies. + /// You may specify the name of the class itself. + /// (TODO: update once Proxies are implemented) + /// </description> + /// </item> + /// <item> + /// <term>dynamic-update</term> + /// <description> + /// (optional - defaults to <c>false</c>) Specifies the <c>UPDATE</c> SQL should + /// be generated at runtime and contain only those columns whose values have changed. + /// </description> + /// </item> + /// <item> + /// <term>dynamic-insert</term> + /// <description> + /// (optional - defaults to <c>false</c>) Specifies the <c>INSERT</c> SQL should + /// be generated at runtime and contain only those columns whose values are not null. + /// </description> + /// </item> + /// <item> + /// <term>polymorphism</term> + /// <description> + /// (optional, defaults to <c>implicit</c>) Determines whether implicit or explicit + /// query polymorphism is used. + /// </description> + /// </item> + /// <item> + /// <term>where</term> + /// <description> + /// (optional) Specify an arbitrary SQL <c>WHERE</c> condition to be used + /// when retrieving objects of this class. + /// </description> + /// </item> + /// <item> + /// <term>persister</term> + /// <description>(optional) Specifies a custom <see cref="Persister.IClassPersister"/>.</description> + /// </item> + /// </list> + /// </remarks> public class RootClass : PersistentClass { *************** *** 111,114 **** --- 189,228 ---- } + /// <summary> + /// Gets or Sets the <see cref="Property"/> to use as the Version Property + /// </summary> + /// <value>The <see cref="Property"/> to use for Versioning.</value> + /// <remarks> + /// <para> + /// The &;tlversion> element is optional and indicates that the table contains versioned data. + /// This is particularly useful if you plan to use long transactions (see below). + /// </para> + /// <para> + /// <list type="table"> + /// <listheader> + /// <term>Attribute</term> + /// <description>Possible Values</description> + /// </listheader> + /// <item> + /// <term>column</term> + /// <description> + /// The name of the <c>column</c> holding the version number. + /// Defaults to the Property name. + /// </description> + /// </item> + /// <item> + /// <term>name</term> + /// <description>The name of the Property in the Persistent Class.</description> + /// </item> + /// <item> + /// <term>type</term> + /// <description> + /// The <see cref="Type.IType"/> of the Property. Defaults to an <see cref="Type.Int32Type"/>. It + /// be any <see cref="Type.IVersionType"/>. + /// </description> + /// </item> + /// </list> + /// </para> + /// </remarks> public override Property Version { *************** *** 117,120 **** --- 231,239 ---- } + /// <summary> + /// Gets a value indicating if the <see cref="PersistentClass" /> is versioned + /// by NHibernate. + /// </summary> + /// <value><c>true</c> if there is a version property.</value> public override bool IsVersioned { |