Skip to content

Commit

Permalink
chore(docs): update yuidoc theme and config
Browse files Browse the repository at this point in the history
  • Loading branch information
dylanfoster committed Jan 17, 2017
1 parent ca56806 commit 3103015
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 8 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"sqlite3": "^3.1.4",
"stream": "0.0.2",
"supertest": "^2.0.1",
"yuidoc-ember-cli-theme": "^1.0.2",
"yuidoc-parch-theme": "^1.0.0",
"yuidocjs": "^0.10.2"
},
"eslintConfig": {
Expand Down
3 changes: 2 additions & 1 deletion src/application.js
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,8 @@ class Application {
}

/**
* loads the models into the model manager
* Loads the models into the model manager using
* {{#crossLink "ModelManager/addModel:method"}}ModelManager#addModel{{/crossLink}}
*
* @private
* @method _addModels
Expand Down
16 changes: 12 additions & 4 deletions src/router.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ class Router {
}

/**
* Bind a set of routes to a namespace
* Bind a set of routes to a namespace.
* Uses {{#crossLink "Router/_buildRoute:method"}}_buildRoute{{/crossLink}} to
* normalize the path
*
* Router.map(function () {
* this.namespace("/users/:userId", [
Expand All @@ -53,6 +55,7 @@ class Router {
* @method namespace
* @param {String} namespace the namespace to bind to, with or without leading slash
* @param {Array[Object]} routes array of routes to bind to the namespace
* @since 0.9.0
*/
namespace(namespace, routes) {
for (const route of routes) {
Expand All @@ -66,7 +69,9 @@ class Router {
}

/**
* register a resource and wire up restful endpoints
* Register a resource and wire up restful endpoints.
* Uses {{#crossLink "Router/_buildRoute:method"}}_buildRoute{{/crossLink}} to
* normalize the path
*
* Router.map(function () {
* this.resource("user");
Expand All @@ -85,7 +90,9 @@ class Router {
}

/**
* register a single route
* Register a single route.
* Uses {{#crossLink "Router/_buildRoute:method"}}_buildRoute{{/crossLink}} to
* normalize the path
*
* Router.map(function () {
* this.route("/user/foo", { using: "users:foo", method: "get" });
Expand All @@ -107,7 +114,8 @@ class Router {
}

/**
* Consistently builds a route from a set of path segments
* Consistently builds a route from a set of path segments using
* {{#crossLink "Route"}}Route{{/crossLink}}
*
* router._buildRoute("foo", "/bar" "baz/");
*
Expand Down
5 changes: 3 additions & 2 deletions yuidoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
"url": "https://github.com/dylanfoster/parch",
"version": "0.7.1",
"options": {
"helpers": ["node_modules/yuidoc-ember-cli-theme/helpers.js"],
"exclude": "lib",
"helpers": ["node_modules/yuidoc-parch-theme/helpers/helpers.js"],
"linkNatives": "true",
"outdir": "docs",
"paths": ["./src"],
"themedir": "node_modules/yuidoc-ember-cli-theme"
"themedir": "node_modules/yuidoc-parch-theme"
}
}

0 comments on commit 3103015

Please sign in to comment.