Enable markdown for all description fields.

DISEINC · Jul 10, 2014 · 705ee7b · 705ee7b
1 parent 68e1ead
commit 705ee7b
Show file tree

Hide file tree

Showing 15 changed files with 267 additions and 171 deletions.
diff --git a/lib/parser.js b/lib/parser.js
@@ -2,6 +2,7 @@ var fs = require("fs");
 var path = require("path");
 var util = require("util");
 var _ = require("underscore");
+var markdown = require("marked");
 
 var app = {};
 
@@ -17,6 +18,9 @@ function Parser(_app)
 	self.parsedFileElements = [];
 	self.parsedFiles = [];
 
+	// Markdown settings
+	markdown.setOptions(app.options.marked);
+
 	// Parser laden
 	var parsers = Object.keys(app.parsers);
 	parsers.forEach(function(parser) {
@@ -116,6 +120,25 @@ Parser.prototype._parseBlockElements = function(indexApiBlocks, detectedElements
 				var result = null;
 				try {
 					result = self.parsers[element.name].parse(element.content, element.source);
+
+					// Markdown
+					// TODO: Evaluate if better add a function in specific worker_{name}.js
+					if(app.options.marked.gfm &&
+						 self.parsers[element.name].markdownFields &&
+						 self.parsers[element.name].markdownFields.length > 0
+					)
+					{
+						for(var markdownIndex = 0; markdownIndex < self.parsers[element.name].markdownFields.length; markdownIndex += 1)
+						{
+							var markdownField = self.parsers[element.name].markdownFields[markdownIndex];
+							if(result[markdownField])
+							{
+								result[markdownField] = markdown(result[markdownField]);
+								// remove line breaks.
+								result[markdownField] = result[markdownField].replace(/(\r\n|\n|\r)/g, "");
+							}
+						} // for
+					}
 				}
 				catch(e)
 				{

diff --git a/lib/plugins/parser_api_define_permission.js b/lib/plugins/parser_api_define_permission.js
@@ -39,5 +39,6 @@ function pushTo()
  */
 module.exports = {
 	parse: parse,
-	pushTo: pushTo
+	pushTo: pushTo,
+	markdownFields: [ "description" ]
 };
diff --git a/lib/plugins/parser_api_description.js b/lib/plugins/parser_api_description.js
@@ -19,5 +19,6 @@ function pushTo()
  */
 module.exports = {
 	parse: parse,
-	pushTo: pushTo
+	pushTo: pushTo,
+	markdownFields: [ "description" ]
 };
diff --git a/lib/plugins/parser_api_error.js b/lib/plugins/parser_api_error.js
@@ -16,5 +16,6 @@ function pushTo()
  */
 module.exports = {
 	parse: parse,
-	pushTo: pushTo
+	pushTo: pushTo,
+	markdownFields: [ "description" ]
 };
diff --git a/lib/plugins/parser_api_group_description.js b/lib/plugins/parser_api_group_description.js
@@ -19,5 +19,6 @@ function pushTo()
  */
 module.exports = {
   parse: parse,
-  pushTo: pushTo
+  pushTo: pushTo,
+	markdownFields: [ "groupDescription" ]
 };
diff --git a/lib/plugins/parser_api_header.js b/lib/plugins/parser_api_header.js
@@ -16,5 +16,6 @@ function pushTo()
  */
 module.exports = {
 	parse: parse,
-	pushTo: pushTo
+	pushTo: pushTo,
+	markdownFields: [ "description" ]
 };
diff --git a/lib/plugins/parser_api_info.js b/lib/plugins/parser_api_info.js
@@ -16,5 +16,6 @@ function pushTo()
  */
 module.exports = {
 	parse: parse,
-	pushTo: pushTo
+	pushTo: pushTo,
+	markdownFields: [ "description" ]
 };
diff --git a/lib/plugins/parser_api_param.js b/lib/plugins/parser_api_param.js
@@ -103,5 +103,6 @@ function getGroup()
 module.exports = {
 	parse: parse,
 	pushTo: pushTo,
-	getGroup: getGroup
+	getGroup: getGroup,
+	markdownFields: [ "description" ]
 };
diff --git a/lib/plugins/parser_api_success.js b/lib/plugins/parser_api_success.js
@@ -16,5 +16,6 @@ function pushTo()
  */
 module.exports = {
 	parse: parse,
-	pushTo: pushTo
+	pushTo: pushTo,
+	markdownFields: [ "description" ]
 };
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "apidoc",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "RESTful web API Documentation Generator",
   "author": "Peter Rottmann <[email protected]>",
   "preferGlobal": true,