apidoc - npm Package Compare versions

Comparing version 0.10.1 to 0.11.0

CHANGELOG.md

 # apiDoc Changelog
 
+#### 0.11.0
 
+* CLI
+  * Add parameter `--parse-languages` for custom language regex.
+
+* Parser
+  * Add Clojure parser for `.clj` files.
+  * Extend parser to transfer own language regex.
+  * Update apidoc-core interface (replace arguments with setters).
+
+* Template
+  * Add chinese and dutch translations files.
+
+
+#### 0.10.1
+
+* Bugfix: Path to apidoc-core.
+
+
 #### 0.10.0
@@ -5,0 +23,0 @@

CONTRIBUTORS.md

@@ -5,2 +5,11 @@ # apiDoc Contributors
 
+* [大鼻子](https://github.com/wohugb)
+  * Add chinese translation (missing translations from google).
+
+* [kimhoo](https://github.com/kimhoo)
+  * Add dutch translation (missing translations from google).
+
+* [Danny Olson](https://github.com/dbolson)
+  * Add Clojure parser.
+
 * [Eugene Jo](https://github.com/iameugenejo)
@@ -7,0 +16,0 @@ * Allowed options.packageInfo to overwrite default packageInfo [#177] (https://github.com/apidoc/apidoc/pull/171))

lib/index.js

 var _        = require('lodash');
-var apidoc = require('apidoc-core/');
+var apidoc   = require('apidoc-core');
 var fs       = require('fs-extra');
@@ -53,2 +53,6 @@ var markdown = require('marked');
 function createDoc(options) {
+    var api;
+    var apidocPath = path.join(__dirname, '../');
+    var packageInfo;
+
     _.defaults(options, defaults);
@@ -83,16 +87,18 @@
     try {
-        var packageInfo = new PackageInfo(app);
-        var packageInfos = packageInfo.get();
+        packageInfo = new PackageInfo(app);
 
         // generator information
-        var apidocPath = path.join(__dirname, '../');
         var json = JSON.parse( fs.readFileSync(apidocPath + 'package.json', 'utf8') );
-        var generator = {
-            version: json.version,
+        apidoc.setGeneratorInfos({
+            name   : json.name,
             time   : new Date(),
-            name   : json.name,
-            url    : json.homepage
-        };
+            url    : json.homepage,
+            version: json.version
+        });
+        apidoc.setLogger(app.log);
+        apidoc.setMarkdownParser(app.markdown);
+        apidoc.setPackageInfos(packageInfo.get());
 
-        var api = apidoc.parse(app.options, app.log, generator, packageInfos, app.markdown);
+        api = apidoc.parse(app.options);
+
         if (api === true) {
@@ -99,0 +105,0 @@ app.log.info('Nothing to do.');

package.json

 {
   "name": "apidoc",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "description": "RESTful web API Documentation Generator",
@@ -23,3 +23,4 @@ "author": "Peter Rottmann <[e-mail]>",
     "test": "npm run jshint && mocha test/",
-    "jshint": "jshint lib/ test/ --exclude test/fixtures/"
+    "jshint": "jshint lib/ test/",
+    "build-example": "bin/apidoc -i example/ -o tmp/"
   },
@@ -26,0 +27,0 @@ "keywords": [

README.md

@@ -1,2 +0,2 @@
-# apiDoc 0.10.x
+# apiDoc
 
@@ -61,2 +61,10 @@ Generates a RESTful web API Documentation.
 
+ * **Clojure**:
+
+   ```clojure
+   ;;;;
+   ;; This is a comment.
+   ;;;;
+   ```
+
  * **CoffeeScript**:
@@ -63,0 +71,0 @@

template/locales/locale.js

 define([
-    './locales/de.js'
+    './locales/de.js',
+    './locales/nl.js',
+    './locales/zh.js'
 ], function() {
@@ -4,0 +6,0 @@ var locales = {};

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

611550

increased by0.56%

Number of package files

69

increased by2.99%

Lines of code

4039

increased by1.41%

Number of lines in readme file

135

increased by6.3%

No dependency changes