Skip to content

NH-3958: documents missing types, fix broken links #565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 7, 2017

Conversation

fredericDelaporte
Copy link
Member

NH-3958: adding some missing NHibernate types in reference documentation.
Fix two broken links, one updated, the other one removed (referencing old Nullables library).
Pushed api version in documentation from 4.0 to 5.0.

@gliljas
Copy link
Member

gliljas commented Mar 5, 2017

Nice! But I see you've also added a Sandcastle project file. Please remove that.

@@ -165,7 +165,7 @@ public class Base {
<para>Instead of using a string for <methodname>DiscriminatorValue</methodname> (in <classname>[Class]</classname> and <classname>[Subclass]</classname>), you can use any object you want. Example: <programlisting>[Subclass(DiscriminatorValueEnumFormat="d", DiscriminatorValueObject=DiscEnum.Val1)]</programlisting> Here, the object is an Enum, and you can set the format you want (the default value is "g"). Note that you must put it <emphasis role="strong">before</emphasis>! For others types, It simply use the <methodname>ToString()</methodname> method of the object.</para>
</listitem>
<listitem>
<para>If you are using members of the type <classname>Nullables.NullableXXX</classname> (from the library <link linkend="nullables">Nullables</link>), then they will be mapped to <classname>Nullables.NHibernate.NullableXXXType</classname> automatically; don't set <literal>Type="..."</literal> in <classname>[Property]</classname> (leave it null). This is also the case for <classname>SqlTypes</classname> (and you can add your own patterns). Thanks to <emphasis>Michael Third</emphasis> for the idea :)</para>
<para>If you are using members of the type <classname>Nullables.NullableXXX</classname> (from the library Nullables), then they will be mapped to <classname>Nullables.NHibernate.NullableXXXType</classname> automatically; don't set <literal>Type="..."</literal> in <classname>[Property]</classname> (leave it null). This is also the case for <classname>SqlTypes</classname> (and you can add your own patterns). Thanks to <emphasis>Michael Third</emphasis> for the idea :)</para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this has to be removed completely. As this, probably does not happen currently. And, nobody is using Nullables library.

@fredericDelaporte
Copy link
Member Author

Sorry for the sandcastle project, I have removed it. I wanted to gitignore it, but done that in another branch. Now I have put a .gitignore in this branch. The Nant build generates this sandcastle project, so it seems legit to ignore it in doc folder.
Hazzik, I have removed the obsolete paragraph.

@hazzik hazzik merged commit 5f32eb3 into nhibernate:master Mar 7, 2017
@fredericDelaporte fredericDelaporte deleted the NH-3958 branch March 7, 2017 10:53
@hazzik hazzik modified the milestone: 5.0.0 Mar 24, 2017
@hazzik hazzik added the r: Fixed label Aug 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants