Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
resolves #16
  • Loading branch information
Yiorgos Trifidis committed Mar 6, 2018
1 parent 4fe7f4e commit 30abc21
Show file tree
Hide file tree
Showing 111 changed files with 3,784 additions and 1,770 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ OrpheusCore/OrpheusCore.config
*.ide
OrpheusDocumentation/_site/
OrpheusDocumentation/DocFx
OrpheusDocumentation/DocFx.original
OrpheusDocumentation/obj
OrpheusDocumentation/examples
OrpheusAttributes/obj
Expand Down Expand Up @@ -47,4 +48,5 @@ Nuget/2.0.0/lib/netstandard2.0/OrpheusSQLServerDDLHelper.xml
OrpheusWebClientTest/ScaffoldingReadMe.txt
*.vssscc
Nuget/PublishPackage.cmd
OrpheusTests/BaseTests/TestDatabaseConnectionStrings.cs
OrpheusTests/BaseTests/TestDatabaseConnectionStrings.cs
Nuget/nuget.exe
2 changes: 1 addition & 1 deletion Nuget/OrpheusORM.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata>
<id>OrpheusORM</id>
<version>1.0.7</version>
<version>1.1.0</version>
<title>OrpheusORM</title>
<authors>Trifidis Yiorgos</authors>
<owners>Trifidis Yiorgos</owners>
Expand Down
2 changes: 1 addition & 1 deletion Nuget/OrpheusORMMySQLServerHelper.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata>
<id>OrpheusORMMySQLServerDDLHelper</id>
<version>1.0.7</version>
<version>1.1.0</version>
<title>OrpheusORM MySQL Server DDL Helper</title>
<authors>Trifidis Yiorgos</authors>
<owners>Trifidis Yiorgos</owners>
Expand Down
2 changes: 1 addition & 1 deletion Nuget/OrpheusORMSQLServerHelper.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
<metadata>
<id>OrpheusORMSQLServerDDLHelper</id>
<version>1.0.7</version>
<version>1.1.0</version>
<title>OrpheusORM SQL Server DDL Helper</title>
<authors>Trifidis Yiorgos</authors>
<owners>Trifidis Yiorgos</owners>
Expand Down
3 changes: 1 addition & 2 deletions OrpheusCore/SchemaBuilder/SchemaObject.cs
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,6 @@ protected override bool canExecuteSchema()
#region schema fields and constraints
/// <summary>
/// Creates fields from a given model.
/// Supports <see cref="System.ComponentModel.DataAnnotations"/> attributes
/// </summary>
/// <param name="model"></param>
public void CreateFieldsFromModel(object model)
Expand Down Expand Up @@ -791,7 +790,7 @@ protected override List<string> createDDLString()
/// <summary>
/// Applies schema's constraints.
/// </summary>
/// <param name="cmd"><see cref="IDbCommand"/></param>
/// <param name="cmd"></param>
protected override void applyConstraints(IDbCommand cmd)
{
//first run the primary key constraints.
Expand Down
2 changes: 1 addition & 1 deletion docs/about/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<title> | Orpheus ORM </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content=" | Orpheus ORM ">
<meta name="generator" content="docfx 2.25.2.0">
<meta name="generator" content="docfx 2.32.1.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down
15 changes: 7 additions & 8 deletions docs/api/OrpheusAttributes.DataTypeAttribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class DataTypeAttribute
| Orpheus ORM ">
<meta name="generator" content="docfx 2.25.2.0">
<meta name="generator" content="docfx 2.32.1.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down Expand Up @@ -88,9 +88,8 @@ <h1 id="OrpheusAttributes_DataTypeAttribute" data-uid="OrpheusAttributes.DataTyp
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">System.Attribute</span></div>
<div class="level2"><a class="xref" href="OrpheusAttributes.OrpheusBaseAttribute.html">OrpheusBaseAttribute</a></div>
<div class="level3"><span class="xref">DataTypeAttribute</span></div>
<div class="level1"><a class="xref" href="OrpheusAttributes.OrpheusBaseAttribute.html">OrpheusBaseAttribute</a></div>
<div class="level2"><span class="xref">DataTypeAttribute</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="OrpheusAttributes.html">OrpheusAttributes</a></h6>
<h6><strong>Assembly</strong>: OrpheusAttributes.dll</h6>
Expand All @@ -102,13 +101,13 @@ <h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/gtrifidis/OrpheusORM/new/master/apiSpec/new?filename=OrpheusAttributes_DataTypeAttribute__ctor_System_Data_DbType_.md&amp;value=---%0Auid%3A%20OrpheusAttributes.DataTypeAttribute.%23ctor(System.Data.DbType)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
<a href="https://github.com/gtrifidis/OrpheusORM/new/master/apiSpec/new?filename=OrpheusAttributes_DataTypeAttribute__ctor_DbType_.md&amp;value=---%0Auid%3A%20OrpheusAttributes.DataTypeAttribute.%23ctor(DbType)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/gtrifidis/OrpheusORM/blob/master/OrpheusAttributes/OrpheusDataTypeAttribute.cs/#L27">View Source</a>
</span>
<a id="OrpheusAttributes_DataTypeAttribute__ctor_" data-uid="OrpheusAttributes.DataTypeAttribute.#ctor*"></a>
<h4 id="OrpheusAttributes_DataTypeAttribute__ctor_System_Data_DbType_" data-uid="OrpheusAttributes.DataTypeAttribute.#ctor(System.Data.DbType)">DataTypeAttribute(DbType)</h4>
<h4 id="OrpheusAttributes_DataTypeAttribute__ctor_DbType_" data-uid="OrpheusAttributes.DataTypeAttribute.#ctor(DbType)">DataTypeAttribute(DbType)</h4>
<div class="markdown level1 summary"><p>Data type attribute constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
Expand All @@ -127,7 +126,7 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Data.DbType</span></td>
<td><span class="xref">DbType</span></td>
<td><span class="parametername">dbType</span></td>
<td><p>Data type</p>
</td>
Expand Down Expand Up @@ -196,7 +195,7 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Data.DbType</span></td>
<td><span class="xref">DbType</span></td>
<td><p>Data type</p>
</td>
</tr>
Expand Down
7 changes: 3 additions & 4 deletions docs/api/OrpheusAttributes.DefaultValue.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class DefaultValue
| Orpheus ORM ">
<meta name="generator" content="docfx 2.25.2.0">
<meta name="generator" content="docfx 2.32.1.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down Expand Up @@ -89,9 +89,8 @@ <h1 id="OrpheusAttributes_DefaultValue" data-uid="OrpheusAttributes.DefaultValue
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">System.Attribute</span></div>
<div class="level2"><a class="xref" href="OrpheusAttributes.OrpheusBaseAttribute.html">OrpheusBaseAttribute</a></div>
<div class="level3"><span class="xref">DefaultValue</span></div>
<div class="level1"><a class="xref" href="OrpheusAttributes.OrpheusBaseAttribute.html">OrpheusBaseAttribute</a></div>
<div class="level2"><span class="xref">DefaultValue</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="OrpheusAttributes.html">OrpheusAttributes</a></h6>
<h6><strong>Assembly</strong>: OrpheusAttributes.dll</h6>
Expand Down
7 changes: 3 additions & 4 deletions docs/api/OrpheusAttributes.FieldName.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class FieldName
| Orpheus ORM ">
<meta name="generator" content="docfx 2.25.2.0">
<meta name="generator" content="docfx 2.32.1.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down Expand Up @@ -89,9 +89,8 @@ <h1 id="OrpheusAttributes_FieldName" data-uid="OrpheusAttributes.FieldName" clas
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">System.Attribute</span></div>
<div class="level2"><a class="xref" href="OrpheusAttributes.OrpheusBaseAttribute.html">OrpheusBaseAttribute</a></div>
<div class="level3"><span class="xref">FieldName</span></div>
<div class="level1"><a class="xref" href="OrpheusAttributes.OrpheusBaseAttribute.html">OrpheusBaseAttribute</a></div>
<div class="level2"><span class="xref">FieldName</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="OrpheusAttributes.html">OrpheusAttributes</a></h6>
<h6><strong>Assembly</strong>: OrpheusAttributes.dll</h6>
Expand Down
66 changes: 53 additions & 13 deletions docs/api/OrpheusAttributes.ForeignKey.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ForeignKey
| Orpheus ORM ">
<meta name="generator" content="docfx 2.25.2.0">
<meta name="generator" content="docfx 2.32.1.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down Expand Up @@ -89,9 +89,8 @@ <h1 id="OrpheusAttributes_ForeignKey" data-uid="OrpheusAttributes.ForeignKey" cl
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">System.Attribute</span></div>
<div class="level2"><a class="xref" href="OrpheusAttributes.OrpheusBaseAttribute.html">OrpheusBaseAttribute</a></div>
<div class="level3"><span class="xref">ForeignKey</span></div>
<div class="level1"><a class="xref" href="OrpheusAttributes.OrpheusBaseAttribute.html">OrpheusBaseAttribute</a></div>
<div class="level2"><span class="xref">ForeignKey</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="OrpheusAttributes.html">OrpheusAttributes</a></h6>
<h6><strong>Assembly</strong>: OrpheusAttributes.dll</h6>
Expand All @@ -103,19 +102,19 @@ <h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/gtrifidis/OrpheusORM/new/master/apiSpec/new?filename=OrpheusAttributes_ForeignKey__ctor_System_String_System_String_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20OrpheusAttributes.ForeignKey.%23ctor(System.String%2CSystem.String%2CSystem.Boolean%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
<a href="https://github.com/gtrifidis/OrpheusORM/new/master/apiSpec/new?filename=OrpheusAttributes_ForeignKey__ctor_System_String_System_String_System_String_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20OrpheusAttributes.ForeignKey.%23ctor(System.String%2CSystem.String%2CSystem.String%2CSystem.Boolean%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/gtrifidis/OrpheusORM/blob/master/OrpheusAttributes/OrpheusForeignKeyAttribute.cs/#L46">View Source</a>
<a href="https://github.com/gtrifidis/OrpheusORM/blob/master/OrpheusAttributes/OrpheusForeignKeyAttribute.cs/#L51">View Source</a>
</span>
<a id="OrpheusAttributes_ForeignKey__ctor_" data-uid="OrpheusAttributes.ForeignKey.#ctor*"></a>
<h4 id="OrpheusAttributes_ForeignKey__ctor_System_String_System_String_System_Boolean_System_Boolean_" data-uid="OrpheusAttributes.ForeignKey.#ctor(System.String,System.String,System.Boolean,System.Boolean)">ForeignKey(String, String, Boolean, Boolean)</h4>
<h4 id="OrpheusAttributes_ForeignKey__ctor_System_String_System_String_System_String_System_Boolean_System_Boolean_" data-uid="OrpheusAttributes.ForeignKey.#ctor(System.String,System.String,System.String,System.Boolean,System.Boolean)">ForeignKey(String, String, String, Boolean, Boolean)</h4>
<div class="markdown level1 summary"><p>Foreign key attribute constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ForeignKey(string referenceTable, string referenceField, bool onDeleteCascade = false, bool onUpdateCascade = false)</code></pre>
<pre><code class="lang-csharp hljs">public ForeignKey(string referenceTable, string referenceField, string schemaName = null, bool onDeleteCascade = false, bool onUpdateCascade = false)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
Expand All @@ -139,6 +138,11 @@ <h5 class="parameters">Parameters</h5>
<td><p>The referenced field name</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">schemaName</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">onDeleteCascade</span></td>
Expand All @@ -155,19 +159,19 @@ <h5 class="parameters">Parameters</h5>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/gtrifidis/OrpheusORM/new/master/apiSpec/new?filename=OrpheusAttributes_ForeignKey__ctor_System_Type_System_String_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20OrpheusAttributes.ForeignKey.%23ctor(System.Type%2CSystem.String%2CSystem.Boolean%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
<a href="https://github.com/gtrifidis/OrpheusORM/new/master/apiSpec/new?filename=OrpheusAttributes_ForeignKey__ctor_Type_System_String_System_String_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20OrpheusAttributes.ForeignKey.%23ctor(Type%2CSystem.String%2CSystem.String%2CSystem.Boolean%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/gtrifidis/OrpheusORM/blob/master/OrpheusAttributes/OrpheusForeignKeyAttribute.cs/#L61">View Source</a>
<a href="https://github.com/gtrifidis/OrpheusORM/blob/master/OrpheusAttributes/OrpheusForeignKeyAttribute.cs/#L67">View Source</a>
</span>
<a id="OrpheusAttributes_ForeignKey__ctor_" data-uid="OrpheusAttributes.ForeignKey.#ctor*"></a>
<h4 id="OrpheusAttributes_ForeignKey__ctor_System_Type_System_String_System_Boolean_System_Boolean_" data-uid="OrpheusAttributes.ForeignKey.#ctor(System.Type,System.String,System.Boolean,System.Boolean)">ForeignKey(Type, String, Boolean, Boolean)</h4>
<h4 id="OrpheusAttributes_ForeignKey__ctor_Type_System_String_System_String_System_Boolean_System_Boolean_" data-uid="OrpheusAttributes.ForeignKey.#ctor(Type,System.String,System.String,System.Boolean,System.Boolean)">ForeignKey(Type, String, String, Boolean, Boolean)</h4>
<div class="markdown level1 summary"><p>Foreign key attribute constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ForeignKey(Type referenceTableType, string referenceField, bool onDeleteCascade = false, bool onUpdateCascade = false)</code></pre>
<pre><code class="lang-csharp hljs">public ForeignKey(Type referenceTableType, string referenceField, string schemaName = null, bool onDeleteCascade = false, bool onUpdateCascade = false)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
Expand All @@ -180,7 +184,7 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Type</span></td>
<td><span class="xref">Type</span></td>
<td><span class="parametername">referenceTableType</span></td>
<td><p>The referenced table type</p>
</td>
Expand All @@ -191,6 +195,11 @@ <h5 class="parameters">Parameters</h5>
<td><p>The referenced field name</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">schemaName</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">onDeleteCascade</span></td>
Expand Down Expand Up @@ -335,6 +344,37 @@ <h5 class="propertyValue">Property Value</h5>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/gtrifidis/OrpheusORM/new/master/apiSpec/new?filename=OrpheusAttributes_ForeignKey_SchemaName.md&amp;value=---%0Auid%3A%20OrpheusAttributes.ForeignKey.SchemaName%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/gtrifidis/OrpheusORM/blob/master/OrpheusAttributes/OrpheusForeignKeyAttribute.cs/#L42">View Source</a>
</span>
<a id="OrpheusAttributes_ForeignKey_SchemaName_" data-uid="OrpheusAttributes.ForeignKey.SchemaName*"></a>
<h4 id="OrpheusAttributes_ForeignKey_SchemaName" data-uid="OrpheusAttributes.ForeignKey.SchemaName">SchemaName</h4>
<div class="markdown level1 summary"><p>Optional. Set the schema name of the reference table, if there is one.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string SchemaName { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
</div>
Expand Down
7 changes: 3 additions & 4 deletions docs/api/OrpheusAttributes.Length.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Length
| Orpheus ORM ">
<meta name="generator" content="docfx 2.25.2.0">
<meta name="generator" content="docfx 2.32.1.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down Expand Up @@ -90,9 +90,8 @@ <h1 id="OrpheusAttributes_Length" data-uid="OrpheusAttributes.Length" class="tex
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">System.Attribute</span></div>
<div class="level2"><a class="xref" href="OrpheusAttributes.OrpheusBaseAttribute.html">OrpheusBaseAttribute</a></div>
<div class="level3"><span class="xref">Length</span></div>
<div class="level1"><a class="xref" href="OrpheusAttributes.OrpheusBaseAttribute.html">OrpheusBaseAttribute</a></div>
<div class="level2"><span class="xref">Length</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="OrpheusAttributes.html">OrpheusAttributes</a></h6>
<h6><strong>Assembly</strong>: OrpheusAttributes.dll</h6>
Expand Down

0 comments on commit 30abc21

Please sign in to comment.