Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/develop'
Browse files Browse the repository at this point in the history 
Update documentation to reflect the 0.2.0 release
  • Loading branch information
@abought
abought committed Feb 12, 2017
2 parents 7077299 + 5d45c85 commit 91799ed
Show file tree
Hide file tree
Showing 169 changed files with 6,137 additions and 746 deletions.
22 changes: 20 additions & 2 deletions docs/api.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ YUI.add("yuidoc-meta", function(Y) {
Y.YUIDoc = { meta: {
"classes": [
"CasAuthenticatedRouteMixin",
"Citation",
"Collection",
"Comment",
"CommentReport",
Expand Down Expand Up @@ -45,6 +46,7 @@ YUI.add("yuidoc-meta", function(Y) {
"User",
"ajax-helpers",
"auth",
"citation-widget",
"comment-detail",
"comment-form",
"comment-pane",
Expand All @@ -59,13 +61,18 @@ YUI.add("yuidoc-meta", function(Y) {
"file-renderer",
"file-version",
"file-widget",
"fix-special-char",
"fix-special-char-helper",
"fixstring",
"navbar-auth-dropdown",
"oauth-popup",
"osf-copyright",
"osf-footer",
"osf-mode-footer",
"osf-navbar",
"osf-paginator",
"pagination-control",
"permissions",
"search-dropdown",
"sign-up",
"tags-widget"
Expand All @@ -75,6 +82,7 @@ YUI.add("yuidoc-meta", function(Y) {
"authenticators",
"authorizers",
"components",
"const",
"ember",
"ember-osf",
"ember-preprints",
Expand All @@ -83,6 +91,7 @@ YUI.add("yuidoc-meta", function(Y) {
"models",
"serializers",
"services",
"transforms",
"utils"
],
"allModules": [
Expand All @@ -104,7 +113,11 @@ YUI.add("yuidoc-meta", function(Y) {
{
"displayName": "components",
"name": "components",
"description": "Display information about an individual comment, including controls to edit, delete, and report.\nThis component is typically used as part of the `comment-pane` component; see that component for further information.\n\nSample usage:\n```handlebars\n{{comment-detail\n comment=comment\n editComment=attrs.editComment\n deleteComment=attrs.deleteComment\n restoreComment=attrs.restoreComment\n reportComment=attrs.reportComment}}\n```"
"description": "Lists citations for node in APA, MLA, and Chicago formats"
},
{
"displayName": "const",
"name": "const"
},
{
"displayName": "ember",
Expand Down Expand Up @@ -132,7 +145,7 @@ YUI.add("yuidoc-meta", function(Y) {
{
"displayName": "models",
"name": "models",
"description": "Model for OSF APIv2 collections\nFor field and usage information, see:\n* https://api.osf.io/v2/docs/#!/v2/Collection_List_GET"
"description": "Model for OSF APIv2 citation styles"
},
{
"displayName": "serializers",
Expand All @@ -144,6 +157,11 @@ YUI.add("yuidoc-meta", function(Y) {
"name": "services",
"description": "Access information about the currently logged in user"
},
{
"displayName": "transforms",
"name": "transforms",
"description": "Custom string field transform that uses the `fix-special-char` utility function to clean up malformed text sent\nfrom the server. This allows string fields to be correctly and transparently used in templates without manually fixing\nthese characters for display on each use.\n\n This transform is used when `fixstring` is passed as the type parameter to the DS.attr function.\n ```app/models/score.js\n import DS from 'ember-data';\n export default DS.Model.extend({\n astring: DS.attr('fixstring'),\n });\n ```"
},
{
"displayName": "utils",
"name": "utils",
Expand Down
15 changes: 12 additions & 3 deletions docs/classes/CasAuthenticatedRouteMixin.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>CasAuthenticatedRouteMixin - Ember OSF</title>
<title>CasAuthenticatedRouteMixin - Ember OSF Addon</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
Expand All @@ -14,10 +14,10 @@
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="https://cos.io/static/img/icons/cos_wide.png" title="Ember OSF"></h1>
<h1><img src="https://cos.io/static/img/icons/cos_wide.png" title="Ember OSF Addon"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.0.1</em>
<em>API Docs for: 0.2.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
Expand All @@ -41,6 +41,8 @@ <h2 class="off-left">APIs</h2>
<li><a href="../classes/ajax-helpers.html">ajax-helpers</a></li>
<li><a href="../classes/auth.html">auth</a></li>
<li><a href="../classes/CasAuthenticatedRouteMixin.html">CasAuthenticatedRouteMixin</a></li>
<li><a href="../classes/Citation.html">Citation</a></li>
<li><a href="../classes/citation-widget.html">citation-widget</a></li>
<li><a href="../classes/Collection.html">Collection</a></li>
<li><a href="../classes/Comment.html">Comment</a></li>
<li><a href="../classes/comment-detail.html">comment-detail</a></li>
Expand All @@ -67,11 +69,15 @@ <h2 class="off-left">APIs</h2>
<li><a href="../classes/FileItemMixin.html">FileItemMixin</a></li>
<li><a href="../classes/FileProvider.html">FileProvider</a></li>
<li><a href="../classes/FileVersion.html">FileVersion</a></li>
<li><a href="../classes/fix-special-char.html">fix-special-char</a></li>
<li><a href="../classes/fix-special-char-helper.html">fix-special-char-helper</a></li>
<li><a href="../classes/fixstring.html">fixstring</a></li>
<li><a href="../classes/GenericDataADapter.html">GenericDataADapter</a></li>
<li><a href="../classes/InfinityCustomMixin.html">InfinityCustomMixin</a></li>
<li><a href="../classes/Institution.html">Institution</a></li>
<li><a href="../classes/Log.html">Log</a></li>
<li><a href="../classes/Metaschema.html">Metaschema</a></li>
<li><a href="../classes/navbar-auth-dropdown.html">navbar-auth-dropdown</a></li>
<li><a href="../classes/Node.html">Node</a></li>
<li><a href="../classes/NodeActionsMixin.html">NodeActionsMixin</a></li>
<li><a href="../classes/NodeLink.html">NodeLink</a></li>
Expand All @@ -97,6 +103,7 @@ <h2 class="off-left">APIs</h2>
<li><a href="../classes/PaginatedControllerMixin.html">PaginatedControllerMixin</a></li>
<li><a href="../classes/PaginatedRouteMixin.html">PaginatedRouteMixin</a></li>
<li><a href="../classes/pagination-control.html">pagination-control</a></li>
<li><a href="../classes/permissions.html">permissions</a></li>
<li><a href="../classes/Preprint.html">Preprint</a></li>
<li><a href="../classes/Registration.html">Registration</a></li>
<li><a href="../classes/RegistrationActionsMixin.html">RegistrationActionsMixin</a></li>
Expand All @@ -114,6 +121,7 @@ <h2 class="off-left">APIs</h2>
<li><a href="../modules/authenticators.html">authenticators</a></li>
<li><a href="../modules/authorizers.html">authorizers</a></li>
<li><a href="../modules/components.html">components</a></li>
<li><a href="../modules/const.html">const</a></li>
<li><a href="../modules/ember.html">ember</a></li>
<li><a href="../modules/ember-osf.html">ember-osf</a></li>
<li><a href="../modules/ember-preprints.html">ember-preprints</a></li>
Expand All @@ -122,6 +130,7 @@ <h2 class="off-left">APIs</h2>
<li><a href="../modules/models.html">models</a></li>
<li><a href="../modules/serializers.html">serializers</a></li>
<li><a href="../modules/services.html">services</a></li>
<li><a href="../modules/transforms.html">transforms</a></li>
<li><a href="../modules/utils.html">utils</a></li>
</ul>
</div>
Expand Down
Loading

0 comments on commit 91799ed

Please sign in to comment.