fix bug

cainmaila · Oct 5, 2016 · a289461 · a289461
1 parent 07f9365
commit a289461
Show file tree

Hide file tree

Showing 40 changed files with 2,335 additions and 3 deletions.
diff --git a/gulp-jsdoc.js b/gulp-jsdoc.js
@@ -81,7 +81,7 @@ function jsdoc(config, done) {
                     cmd = require.resolve('jsdoc/jsdoc.js'),
                     // Needed to handle npm3 - find the binary anywhere
                     // inkdocstrap = _path2.default.dirname(require.resolve('ink-docstrap'));
-                    inkdocstrap = "./node_modules/leedian-jsdoc/node_modules/jaguarjs-jsdoc";
+                    inkdocstrap = "./node_modules/leedian-jsdoc/jaguarjs-jsdoc";
                 var args = ['-c', tmpobj.name];
 
                 // Config + ink-docstrap if user did not specify their own layout or template

diff --git a/jaguarjs-jsdoc/.npmignore b/jaguarjs-jsdoc/.npmignore
@@ -0,0 +1,3 @@
+/node_modules
+/src
+.gitignore
diff --git a/jaguarjs-jsdoc/LICENSE b/jaguarjs-jsdoc/LICENSE
@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Sangmin, Shim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/jaguarjs-jsdoc/README.md b/jaguarjs-jsdoc/README.md
@@ -0,0 +1,66 @@
+# Jaguar.js template for JSDoc 3
+
+- [Jaguar.js](http://jaguarjs.com/)
+- [Jaguar.js Documentations](http://jaguarjs.com/doc/)
+- [JSDoc3](https://github.com/jsdoc3/jsdoc)
+- [JSDoc3 API Documentations](http://usejsdoc.org)
+
+## Installation
+
+Install the template using NPM:
+
+```bash
+npm install jaguarjs-jsdoc --save-dev
+```
+
+## Usage
+
+If you already have JSDoc system, you can use this project as JSDoc template. More information about JSDoc command-line arguments can be found [here](http://usejsdoc.org/about-commandline.html).
+
+```bash
+jsdoc -c conf.json -R README.md
+```
+
+### conf.json
+
+You can set options for customizing your documentations. Notice the `"template"` field for setting the path to **jaguarjs-jsdoc**.
+
+```json
+"templates": {
+    "applicationName": "Demo",
+    "disqus": "",
+    "googleAnalytics": "",
+    "openGraph": {
+        "title": "",
+        "type": "website",
+        "image": "",
+        "site_name": "",
+        "url": ""
+    },
+    "meta": {
+        "title": "",
+        "description": "",
+        "keyword": ""
+    },
+    "linenums": true,
+    "source": {
+        "include": [
+            "./src/"
+        ],
+        "includePattern": ".+\\.js(doc)?$",
+        "excludePattern": "(^|\\/|\\\\)_"
+    },
+    "opts": {
+        "encoding": "utf8",
+        "recurse": true,
+        "private": false,
+        "lenient": true,
+        "destination": "./docs",
+        "template": "./node_modules/jaguarjs-jsdoc"
+    }
+}
+```
+
+## License
+
+This project under the MIT License. and this project refered by default template for JSDoc 3.
diff --git a/jaguarjs-jsdoc/package.json b/jaguarjs-jsdoc/package.json
@@ -0,0 +1,76 @@
+{
+  "name": "jaguarjs-jsdoc",
+  "version": "1.0.1",
+  "description": "Jaguar.js template for JSDoc 3",
+  "dependencies": {},
+  "devDependencies": {
+    "jshint": "^2.9.2",
+    "less": "^2.7.1",
+    "less-plugin-clean-css": "^1.5.1",
+    "rimraf": "^2.5.2",
+    "uglify-js": "^2.6.2"
+  },
+  "scripts": {
+    "clean": "rimraf static/**/jaguar.*",
+    "lint": "jshint publish.js src/scripts/*.js || exit 0",
+    "build": "npm run clean && npm run lint && npm run build:js && npm run build:css",
+    "build:js": "uglifyjs src/scripts/*.js -m -o static/scripts/jaguar.js",
+    "build:css": "lessc src/styles/jaguar.less static/styles/jaguar.css --clean-css",
+    "test": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/pixijs/jaguarjs-jsdoc.git"
+  },
+  "keywords": [
+    "jsdoc",
+    "jsdoc3",
+    "jaguar.js",
+    "template"
+  ],
+  "author": {
+    "name": "davidshimjs"
+  },
+  "contributors": [
+    {
+      "name": "Matt Karl",
+      "email": "matt@mattkarl.com"
+    }
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/pixijs/jaguarjs-jsdoc/issues"
+  },
+  "gitHead": "53b0d31d273abf56210ee9fbadbb81e1683a15cb",
+  "homepage": "https://github.com/pixijs/jaguarjs-jsdoc#readme",
+  "_id": "jaguarjs-jsdoc@1.0.1",
+  "_shasum": "b127dd9fe6554f13c9e74f4e0710bdeb6a53026d",
+  "_from": "jaguarjs-jsdoc@>=1.0.0 <2.0.0",
+  "_npmVersion": "2.14.12",
+  "_nodeVersion": "4.2.4",
+  "_npmUser": {
+    "name": "bigtimebuddy",
+    "email": "matt@mattkarl.com"
+  },
+  "dist": {
+    "shasum": "b127dd9fe6554f13c9e74f4e0710bdeb6a53026d",
+    "tarball": "https://registry.npmjs.org/jaguarjs-jsdoc/-/jaguarjs-jsdoc-1.0.1.tgz"
+  },
+  "maintainers": [
+    {
+      "name": "bigtimebuddy",
+      "email": "matt@mattkarl.com"
+    },
+    {
+      "name": "joechamm",
+      "email": "joechamm@gmail.com"
+    }
+  ],
+  "_npmOperationalInternal": {
+    "host": "packages-12-west.internal.npmjs.com",
+    "tmp": "tmp/jaguarjs-jsdoc-1.0.1.tgz_1472131203514_0.15155840199440718"
+  },
+  "directories": {},
+  "_resolved": "https://registry.npmjs.org/jaguarjs-jsdoc/-/jaguarjs-jsdoc-1.0.1.tgz",
+  "readme": "ERROR: No README data found!"
+}