Skip to content

Commit

Permalink
Merge pull request #43 from sushihangover/docs3
Browse files Browse the repository at this point in the history
Update docs to match the 1.1.9 release
  • Loading branch information
sushihangover authored Mar 5, 2017
2 parents ccc8f02 + cd1e806 commit 1c518a2
Show file tree
Hide file tree
Showing 5 changed files with 117 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

[![Build status](https://ci.appveyor.com/api/projects/status/ronof3ruyjpl1c4v/branch/master?svg=true)](https://ci.appveyor.com/project/sushihangover/realm-json-extensions/branch/master)


##Nuget:

<div class="nuget-badge">
Expand All @@ -33,7 +32,6 @@ Post on [StackOverflow](http://stackoverflow.com/questions/tagged/xamarin+realm)

[https://sushihangover.github.io/Realm.Json.Extensions/](https://sushihangover.github.io/Realm.Json.Extensions/)


##Extension API:

* A Realm Instance:
Expand All @@ -50,6 +48,13 @@ Post on [StackOverflow](http://stackoverflow.com/questions/tagged/xamarin+realm)
* .NonManagedCopy\<T\>()
* .NonManagedCopy()

* A RealmResult Instance (IQueryable):
* .NonManagedCopy<T>

##Github Repo:

[https://github.com/sushihangover/Realm.Json.Extensions](https://github.com/sushihangover/Realm.Json.Extensions)

##Usage / Examples:

###Single RealmObject from Json-based Strings:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@
<tr class="even"><td class="entry"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a09f5eb7820f51aa75c7f51def9edcc72">ExMalFormeJsonMessage</a></td><td class="entry"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html">SushiHangover.RealmJson.RealmDoesJson</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a7c3dfe4f916b49b0fad84a62230f891f">NonManagedCopy</a>(this RealmObject realmObject)</td><td class="entry"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html">SushiHangover.RealmJson.RealmDoesJson</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#ae8ebc3c7cfe3f30f4ed3484ef804e84a">NonManagedCopy&lt; T &gt;</a>(this RealmObject realmObject)</td><td class="entry"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html">SushiHangover.RealmJson.RealmDoesJson</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a374e4ccaed839107e1359e95b91a93f6">NonManagedCopy&lt; T &gt;</a>(this IQueryable&lt; T &gt; results)</td><td class="entry"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html">SushiHangover.RealmJson.RealmDoesJson</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a085500d6fe5f05f265df55146c5c45ef">NonManagedCopy&lt; T &gt;</a>(this IList&lt; T &gt; list)</td><td class="entry"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html">SushiHangover.RealmJson.RealmDoesJson</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
</table></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.9.1-->
<!-- start footer part -->
Expand Down
106 changes: 105 additions & 1 deletion docs/class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,12 @@
<tr class="memitem:a7c3dfe4f916b49b0fad84a62230f891f"><td class="memItemLeft" align="right" valign="top">static RealmObject&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a7c3dfe4f916b49b0fad84a62230f891f">NonManagedCopy</a> (this RealmObject realmObject)</td></tr>
<tr class="memdesc:a7c3dfe4f916b49b0fad84a62230f891f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a non-managed RealmObject Copy. <a href="#a7c3dfe4f916b49b0fad84a62230f891f">More...</a><br /></td></tr>
<tr class="separator:a7c3dfe4f916b49b0fad84a62230f891f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a374e4ccaed839107e1359e95b91a93f6"><td class="memItemLeft" align="right" valign="top">static IQueryable&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a374e4ccaed839107e1359e95b91a93f6">NonManagedCopy&lt; T &gt;</a> (this IQueryable&lt; T &gt; results)</td></tr>
<tr class="memdesc:a374e4ccaed839107e1359e95b91a93f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a non-managed copy of Realm's Query Result. <a href="#a374e4ccaed839107e1359e95b91a93f6">More...</a><br /></td></tr>
<tr class="separator:a374e4ccaed839107e1359e95b91a93f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a085500d6fe5f05f265df55146c5c45ef"><td class="memItemLeft" align="right" valign="top">static IList&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a085500d6fe5f05f265df55146c5c45ef">NonManagedCopy&lt; T &gt;</a> (this IList&lt; T &gt; list)</td></tr>
<tr class="memdesc:a085500d6fe5f05f265df55146c5c45ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a non-managed copy of Realm's Query Result. <a href="#a085500d6fe5f05f265df55146c5c45ef">More...</a><br /></td></tr>
<tr class="separator:a085500d6fe5f05f265df55146c5c45ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
Expand Down Expand Up @@ -561,7 +567,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7c3dfe4f916b49b0fad84a62
</div>
</div>
<a id="ae8ebc3c7cfe3f30f4ed3484ef804e84a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8ebc3c7cfe3f30f4ed3484ef804e84a">&#9670;&nbsp;</a></span>NonManagedCopy< T >()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ae8ebc3c7cfe3f30f4ed3484ef804e84a">&#9670;&nbsp;</a></span>NonManagedCopy< T >() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -607,6 +613,104 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae8ebc3c7cfe3f30f4ed3484e
</dl>
</div>

</div>
</div>
<a id="a374e4ccaed839107e1359e95b91a93f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a374e4ccaed839107e1359e95b91a93f6">&#9670;&nbsp;</a></span>NonManagedCopy< T >() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static IQueryable&lt;T&gt; <a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a7c3dfe4f916b49b0fad84a62230f891f">SushiHangover.RealmJson.RealmDoesJson.NonManagedCopy</a>&lt; T &gt; </td>
<td>(</td>
<td class="paramtype">this IQueryable&lt; T &gt;&#160;</td>
<td class="paramname"><em>results</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p>Create a non-managed copy of Realm's Query Result. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">results</td><td>Realm collection</td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the RealmObject in the results.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The collection of non-managed realm objects.</dd></dl>
<div class="typeconstraint">
<dl><dt><b>Type Constraints</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em>T</em></td><td>&#160;:</td><td valign="top"><em>RealmObject</em></td><td>&#160;</td></tr>
</table>
</dd>
</dl>
</div>

</div>
</div>
<a id="a085500d6fe5f05f265df55146c5c45ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a085500d6fe5f05f265df55146c5c45ef">&#9670;&nbsp;</a></span>NonManagedCopy< T >() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static IList&lt;T&gt; <a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a7c3dfe4f916b49b0fad84a62230f891f">SushiHangover.RealmJson.RealmDoesJson.NonManagedCopy</a>&lt; T &gt; </td>
<td>(</td>
<td class="paramtype">this IList&lt; T &gt;&#160;</td>
<td class="paramname"><em>list</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p>Create a non-managed copy of Realm's Query Result. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">results</td><td>Realm collection</td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Type of the RealmObject in the results.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The collection of non-managed realm objects.</dd></dl>
<div class="typeconstraint">
<dl><dt><b>Type Constraints</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em>T</em></td><td>&#160;:</td><td valign="top"><em>RealmObject</em></td><td>&#160;</td></tr>
</table>
</dd>
</dl>
</div>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
: <a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a7c3dfe4f916b49b0fad84a62230f891f">SushiHangover.RealmJson.RealmDoesJson</a>
</li>
<li>NonManagedCopy&lt; T &gt;()
: <a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#ae8ebc3c7cfe3f30f4ed3484ef804e84a">SushiHangover.RealmJson.RealmDoesJson</a>
: <a class="el" href="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a085500d6fe5f05f265df55146c5c45ef">SushiHangover.RealmJson.RealmDoesJson</a>
</li>
</ul>
</div><!-- contents -->
Expand Down
2 changes: 2 additions & 0 deletions docs/index.hhc
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
<LI><OBJECT type="text/sitemap"><param name="Name" value="CreateOrUpdateObjectFromJson&lt; T &gt;"><param name="Local" value="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a0e74fc8a617bd92a82045a47d53204c0"><param name="ImageNumber" value="11"></OBJECT>
<LI><OBJECT type="text/sitemap"><param name="Name" value="NonManagedCopy"><param name="Local" value="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a7c3dfe4f916b49b0fad84a62230f891f"><param name="ImageNumber" value="11"></OBJECT>
<LI><OBJECT type="text/sitemap"><param name="Name" value="NonManagedCopy&lt; T &gt;"><param name="Local" value="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#ae8ebc3c7cfe3f30f4ed3484ef804e84a"><param name="ImageNumber" value="11"></OBJECT>
<LI><OBJECT type="text/sitemap"><param name="Name" value="NonManagedCopy&lt; T &gt;"><param name="Local" value="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a374e4ccaed839107e1359e95b91a93f6"><param name="ImageNumber" value="11"></OBJECT>
<LI><OBJECT type="text/sitemap"><param name="Name" value="NonManagedCopy&lt; T &gt;"><param name="Local" value="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a085500d6fe5f05f265df55146c5c45ef"><param name="ImageNumber" value="11"></OBJECT>
<LI><OBJECT type="text/sitemap"><param name="Name" value="ExMalFormeJsonMessage"><param name="Local" value="class_sushi_hangover_1_1_realm_json_1_1_realm_does_json.html#a09f5eb7820f51aa75c7f51def9edcc72"><param name="ImageNumber" value="11"></OBJECT>
</UL>
</UL>
Expand Down

0 comments on commit 1c518a2

Please sign in to comment.