New jsdoc config

bjornharrtell · Nov 26, 2017 · 0979cde · 0979cde
1 parent d2aace7
commit 0979cde
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/doc/jsdoc.json b/doc/jsdoc.json
@@ -0,0 +1,32 @@
+{
+    "opts": {
+        "recurse": true,
+        "destination": "dist/doc"
+    },
+    "tags": {
+        "allowUnknownTags": true
+    },
+    "source": {
+        "includePattern": ".+\\.js(doc)?$",
+        "excludePattern": "(^|\\/|\\\\)_",
+        "exclude": [
+        ],
+        "include": [
+          "src", "doc/jsdoc.md"
+        ]
+    },
+    "plugins": [
+        "node_modules/jsdoc/plugins/markdown"
+    ],
+    "templates": {
+        "cleverLinks": true,
+        "systemName": "JSTS",
+        "copyright": "Björn Harrtell",
+        "monospaceLinks": true,
+        "default": {
+            "outputSourceFiles": true,
+            "useLongnameInNav": true
+        },
+        "applicationName": "JSTS"
+    }
+}
diff --git a/doc/jsdoc.md b/doc/jsdoc.md
@@ -0,0 +1 @@
+This API documentation is for the ES6 source and describe the manually ported IO-classes. Note that the `jsts` packages also exposes the same public API as `org.locationtech.jts` in the [JTS API](http://locationtech.github.io/jts/javadoc).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		This API documentation is for the ES6 source and describe the manually ported IO-classes. Note that the `jsts` packages also exposes the same public API as `org.locationtech.jts` in the [JTS API](http://locationtech.github.io/jts/javadoc).