Skip to content

Commit

Permalink
Update docs and files to distribute
Browse files Browse the repository at this point in the history
  • Loading branch information
Travis committed Jul 14, 2014
1 parent d07e26a commit f95704d
Show file tree
Hide file tree
Showing 7 changed files with 104 additions and 128 deletions.
178 changes: 90 additions & 88 deletions familysearch-javascript-sdk.js

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions familysearch-javascript-sdk.min.js

Large diffs are not rendered by default.

15 changes: 3 additions & 12 deletions js/docs-setup.js
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ NG_DOCS={
"type": "function",
"moduleName": "memories",
"shortDescription": "Get references to memories for a person",
"keywords": "__note__ _all_ api appear array attached convenience currently docs editable endpoint example familysearch full function functions getmemorypersonarefs http https includes init memories memory memorypersonaref memorypersonarefs multiple net options opts org params pass person person-memory-references personas pid promise references response types unused url"
"keywords": "api array convenience currently docs editable endpoint example familysearch full function functions getmemorypersonarefs http https includes init memories memorypersonaref memorypersonarefs net options opts org params pass person person-memory-references pid promise references response types unused url"
},
{
"section": "api",
Expand Down Expand Up @@ -750,15 +750,6 @@ NG_DOCS={
"shortDescription": "Get the specified person",
"keywords": "api convenience currently docs editable example familysearch full function functions getperson http https includes init net options opts org params pass person pid promise response types unused url"
},
{
"section": "api",
"id": "person.functions:getPersonChangeSummary",
"shortName": "getPersonChangeSummary",
"type": "function",
"moduleName": "person",
"shortDescription": "Get the change summary for a person. For detailed change information see functions in the changeHistory module",
"keywords": "api array broken change changehistory changes convenience currently detailed docs editable endpoint example familysearch full function functions getchanges http https includes init module net options opts org params pass person person-change-summary pid promise response rest sandbox summary types unused url"
},
{
"section": "api",
"id": "person.functions:getPersonWithRelationships",
Expand Down Expand Up @@ -1027,7 +1018,7 @@ NG_DOCS={
"type": "function",
"moduleName": "sourceBox",
"shortDescription": "Collection",
"keywords": "$delete $getsourcedescriptions $save api attributes attribution collection count create data delete deletecollection descriptions docs editable empty example familysearch fulfilled function functions getcollectionsourcedescriptions http https init maximum net number object optional options opts org params pass promise property read refresh response return size source sourcebox sources start title true types updated updating user-defined zero-based"
"keywords": "$delete $getcollectionurl $getsourcedescriptions $save api attributes attribution collection count create data delete deletecollection descriptions docs editable empty example familysearch fulfilled function functions getcollectionsourcedescriptions http https init maximum net number object optional options opts org params pass person promise property read refresh response return size source sourcebox sources start title true types updated updating url user-defined zero-based"
},
{
"section": "api",
Expand Down Expand Up @@ -1162,7 +1153,7 @@ NG_DOCS={
"type": "function",
"moduleName": "sources",
"shortDescription": "Description of a source",
"keywords": "$delete $getcitation $getsourcerefsquery $gettext $gettitle $save $setcitation $settext $settitle _about_ api attributes attribution change changemessage citation create data delete deletesourcedescription deletion description docs editable example existing familysearch fulfilled function functions getsourcerefsquery http https init memory message net object optional options opts org pass promise property read reason record refer references refresh response source sourcedescription sources text title true types update updated updating url"
"keywords": "$delete $getcitation $getsourcedescriptionurl $getsourcerefsquery $gettext $gettitle $save $setcitation $settext $settitle _about_ api attributes attribution change changemessage citation create data delete deletesourcedescription deletion description docs editable example existing familysearch fulfilled function functions getsourcerefsquery http https init memory message net object optional options opts org pass promise property read reason record refer references refresh response source sourcedescription sources text title true types update updated updating url"
},
{
"section": "api",
Expand Down
2 changes: 0 additions & 2 deletions partials/api/memories.functions.getMemoryPersonaRefs.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ <h1><code ng:non-bindable="">getMemoryPersonaRefs</code>
<ul>
<li><code>getMemoryPersonaRefs()</code> - get an array of <a href="#/api/memories.types:constructor.MemoryPersonaRef">MemoryPersonaRefs</a> from the response</li>
</ul>
<p><strong>NOTE</strong> currently, if a memory has multiple personas and one of them it attached to a person, <em>all</em> of the personas
for the memory will appear in the results for the person.</p>
<p><a href="https://familysearch.org/developers/docs/api/tree/Person_Memory_References_resource">FamilySearch API Docs</a></p>
<p><a href="http://jsfiddle.net/DallanQ/vt79D/">editable example</a></p>
</div></div>
Expand Down
23 changes: 0 additions & 23 deletions partials/api/person.functions.getPersonChangeSummary.html

This file was deleted.

4 changes: 4 additions & 0 deletions partials/api/sourceBox.types.constructor.Collection.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
</div></td></tr></tbody></table><h5 id="methods_$delete_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="sourcebox-types-page sourcebox-types-constructor-collection-delete-page"><p>promise for the collection id</p>
</div></td></tr></table></div>
</li>
<li><h3 id="methods_$getcollectionurl">$getCollectionUrl()</h3>
<div class="$getcollectionurl"><h5 id="methods_$getcollectionurl_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="sourcebox-types-page sourcebox-types-constructor-collection-getcollectionurl-page"><p>Url of the person</p>
</div></td></tr></table></div>
</li>
<li><h3 id="methods_$getsourcedescriptions">$getSourceDescriptions(params)</h3>
<div class="$getsourcedescriptions"><h5 id="methods_$getsourcedescriptions_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>params <div><em>(optional)</em></div></td><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="sourcebox-types-page sourcebox-types-constructor-collection-getsourcedescriptions-page"><p><code>count</code> maximum to return (defaults to 25), <code>start</code> zero-based index of first source to return</p>
</div></td></tr></tbody></table><h5 id="methods_$getsourcedescriptions_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="sourcebox-types-page sourcebox-types-constructor-collection-getsourcedescriptions-page"><p>promise for the <a href="#/api/sourceBox.functions:getCollectionSourceDescriptions">getCollectionSourceDescriptions</a> response</p>
Expand Down
4 changes: 4 additions & 0 deletions partials/api/sources.types.constructor.SourceDescription.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ <h4 id="usage_parameters">Parameters</h4><table class="variables-matrix table ta
<div class="$getcitation"><h5 id="methods_$getcitation_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="sources-types-page sources-types-constructor-sourcedescription-getcitation-page"><p>source citation</p>
</div></td></tr></table></div>
</li>
<li><h3 id="methods_$getsourcedescriptionurl">$getSourceDescriptionUrl()</h3>
<div class="$getsourcedescriptionurl"><h5 id="methods_$getsourcedescriptionurl_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="sources-types-page sources-types-constructor-sourcedescription-getsourcedescriptionurl-page"><p>Url of the of this source description</p>
</div></td></tr></table></div>
</li>
<li><h3 id="methods_$getsourcerefsquery">$getSourceRefsQuery()</h3>
<div class="$getsourcerefsquery"><h5 id="methods_$getsourcerefsquery_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">Object</a></td><td><div class="sources-types-page sources-types-constructor-sourcedescription-getsourcerefsquery-page"><p>promise for the <a href="#/api/sources.functions:getSourceRefsQuery">getSourceRefsQuery</a> response</p>
</div></td></tr></table></div>
Expand Down

0 comments on commit f95704d

Please sign in to comment.