apidoc - npm Package Compare versions

Comparing version 0.5.2 to 0.6.0

CHANGELOG.md

 # apiDoc Changelog
 
+#### 0.6.0
+Enable markdown for all description fields.
+Add `apidoc.json` configuration file for primary configuration over `package.json`. (http://apidocjs.com/#configuration)
+Add template specific configuration settings. (http://apidocjs.com/#configuration-template-settings)
+Add support for Perl (Doxygen) comment-style.
+Add simple CSS3 preloader.
+
 #### 0.5.2
-* Add css for printing.
-* Bugfix: Template IE8 compatibility. (https://github.com/apidoc/apidoc/issues/69)
+Add css for printing.
+Bugfix: Template IE8 compatibility. (https://github.com/apidoc/apidoc/issues/69)
 
 #### 0.5.1
-* Update node version to 0.10.x.
-* Add optional custom browser title with `apidoc.title` in `package.json`. 
-* Add optional url endpoint with `apidoc.url` in `package.json`.
-* Bugfix: Template scrollbug. (https://github.com/apidoc/apidoc/issues/64)
+Update node version to 0.10.x.
+Add optional custom browser title with `apidoc.title` in `package.json`. 
+Add optional url endpoint with `apidoc.url` in `package.json`.
+Bugfix: Template scrollbug. (https://github.com/apidoc/apidoc/issues/64)
 
 #### 0.5.0
-* Add new Functions:
-  * [@apiGroupDescription](http://apidocjs.com/#param-api-group-description)
-  * [@apiHeader](http://apidocjs.com/#param-api-header)
-  * [@apiHeaderTitle](http://apidocjs.com/#param-api-header-title)
-  * [@apiDefineHeaderStructure](http://apidocjs.com/#param-api-define-header-structure)
-  * [@apiHeaderStructure](http://apidocjs.com/#param-api-header-structure)
-* Remove package.json path `apidocFilename`.
-* Change package.json path `apidoc`.
-  * Add `apidoc.header` / `apidoc.footer` (with custom navigation titles). (http://apidocjs.com/#headerfooter)
-* Remove template basic (easier to maintain), the default template will be re-designed in a future version too.
-* Update template libraries.
-* Add test cases.
+Add new Functions:
+* [@apiGroupDescription](http://apidocjs.com/#param-api-group-description)
+* [@apiHeader](http://apidocjs.com/#param-api-header)
+* [@apiHeaderTitle](http://apidocjs.com/#param-api-header-title)
+* [@apiDefineHeaderStructure](http://apidocjs.com/#param-api-define-header-structure)
+* [@apiHeaderStructure](http://apidocjs.com/#param-api-header-structure)
 
+Remove package.json path `apidocFilename`.
+Change package.json path `apidoc`.
+Add `apidoc.header` / `apidoc.footer` (with custom navigation titles). (http://apidocjs.com/#headerfooter)
+Remove template basic (easier to maintain), the default template will be re-designed in a future version too.
+Update template libraries.
+Add test cases.
+
 #### 0.4.4
@@ -45,2 +53,3 @@ Preserve other files when copying template files to the destination output dir.
 * Ruby
+
 Add some programming language test cases.
@@ -89,2 +98,3 @@ Remove german code comments.
 * [@apiErrorTitle](http://apidocjs.com/#param-api-error-title)
+
 Minor Template-Bugfixes.
@@ -91,0 +101,0 @@

CONTRIBUTORS.md

@@ -5,2 +5,5 @@ # apiDoc Contributors
 
+* [Anton Fischer](https://github.com/antonfisher)
+  * Perl (Doxygen) support ([#71] (https://github.com/apidoc/apidoc/pull/71))
+
 * [Ruslan Ismagilov](https://github.com/isRuslan)
@@ -7,0 +10,0 @@ * Add Function `@apiGroupDescription` ([#54](https://github.com/apidoc/apidoc/pull/54))

lib/apidoc.js

@@ -6,6 +6,6 @@ var _ = require("underscore");
 var path = require("path");
+var PackageInfo = require("./package_info");
 var Parser = require("./parser");
 var Worker = require("./worker");
 var Filter = require("./filter");
-var markdown = require("marked");
 var colors = require("colors");
@@ -17,3 +17,3 @@ var fs = require("fs-extra");
 	excludeFilters: [],
-	includeFilters: [ ".*\\.(coffee|cs|dart|erl|go|java|js|php?|py|rb|ts)$" ],
+	includeFilters: [ ".*\\.(coffee|cs|dart|erl|go|java|js|php?|py|rb|ts|pm)$" ],
 
@@ -88,2 +88,3 @@ src: path.join(__dirname, "../example/"),
 	logWarn: logWarn,
+	options: options,
 	filters: {
@@ -142,73 +143,2 @@ apierror                 : "./plugins/filter_api_error.js",
 /**
- * Read package.json Data and optianl descriptions
- */
-function getPackageData()
-{
-	var packageInfos = {};
-	try
-	{
-		var filename = path.join(options.src, "package.json");
-		if( ! fs.existsSync(filename))
-		{
-			filename = "./package.json";
-		}
-		var json = JSON.parse( fs.readFileSync(filename, "utf8") );
-		app.debug("read: " + filename);
-
-		packageInfos.name        = json.name;
-		packageInfos.version     = json.version;
-		packageInfos.description = json.description;
-		packageInfos.title       = json.apidoc.title;
-
-		// HINT: url could be replaced in the future with an @apiVariable, so versioning could be used.
-		packageInfos.url         = json.apidoc.url;
-
-		if(json.apidoc.header && json.apidoc.header.filename)
-		{
-			var filename = path.join(options.src, json.apidoc.header.filename);
-			if( ! fs.existsSync(filename))
-			{
-				filename = path.join("./", json.apidoc.header.filename);
-			}
-			packageInfos.header = {
-				title  : json.apidoc.header.title,
-				content: markdown( fs.readFileSync(filename, "utf8") )
-			};
-			app.debug("read: " + filename);
-		}
-
-		if(json.apidoc.footer && json.apidoc.footer.filename)
-		{
-			var filename = path.join(options.src, json.apidoc.footer.filename);
-			if( ! fs.existsSync(filename))
-			{
-				filename = path.join("./", json.apidoc.footer.filename);
-			}
-			packageInfos.footer = {
-				title  : json.apidoc.footer.title,
-				content: markdown( fs.readFileSync(filename, "utf8") )
-			};
-			app.debug("read: " + filename);
-		}
-	}
-	catch(e) {
-		app.debug("No package.json found!");
-	}
-
-	// Generator Information
-	try
-	{
-		var apidocPath = path.join(__dirname, "../");
-		var json = JSON.parse( fs.readFileSync(apidocPath + "package.json", "utf8") );
-		packageInfos.generator = {
-			version: json.version,
-			time: new Date()
-		};
-	}
-	catch(e) {}
-
-	return packageInfos;
-} // getPackageData
-
-/**
  * Output parsed content to files
@@ -308,16 +238,16 @@ *
 {
-    var files = findFiles(options);
+	var files = findFiles(options);
 	// Parser
 	for(var i = 0; i < files.length; i += 1)
 	{
-	  	var filename = options.src + files[i];
-	   	var parsedFile = parser.parseFile(filename);
-	   	if(parsedFile)
-	   	{
-	 	   app.log("parse file: " + filename);
-   	       parsedFiles.push(parsedFile);
-   		   parsedFilenames.push(filename);
-  	    }
-    } // for
-}
+		var filename = options.src + files[i];
+		var parsedFile = parser.parseFile(filename);
+		if(parsedFile)
+		{
+			app.log("parse file: " + filename);
+			parsedFiles.push(parsedFile);
+			parsedFilenames.push(filename);
+		}
+	} // for
+} // parseFiles
 
@@ -334,5 +264,2 @@ /**
 
-	// marked (markdown) Settings.
-	markdown.setOptions(options.marked);
-
 	// Paths
@@ -348,2 +275,6 @@ options.dest     = path.join(options.dest, "./");
 
+	// Options
+	app.options = options;
+
+	var packageInfo = new PackageInfo(app);
 	var parser = new Parser(app);
@@ -363,15 +294,15 @@ var parsedFiles = [];
 			{
-			   // Keep same options for each folder, but ensure the "src" of options 
-			   // is the folder currently being processed.
-			   var folderOptions = options;
-			   folderOptions.src = path.join(folder, "./");
-			   parseFiles(parser, folderOptions, parsedFiles, parsedFilenames);
-		    });
-		 }
-		 else
-		 {
-		 	// If the input option for source is a single folder, parse as usual.
-		 	options.src = path.join(options.src, "./");
-            parseFiles(parser, options, parsedFiles, parsedFilenames);
-		 }
+				// Keep same options for each folder, but ensure the "src" of options 
+				// is the folder currently being processed.
+				var folderOptions = options;
+				folderOptions.src = path.join(folder, "./");
+				parseFiles(parser, folderOptions, parsedFiles, parsedFilenames);
+			});
+		}
+		else
+		{
+			// If the input option for source is a single folder, parse as usual.
+			options.src = path.join(options.src, "./");
+			parseFiles(parser, options, parsedFiles, parsedFilenames);
+		}
 
@@ -384,4 +315,3 @@ // Worker / Filter
 
-			var packageInfos = getPackageData();
-			createOutputFiles(parsedFiles, parsedFilenames, packageInfos);
+			createOutputFiles(parsedFiles, parsedFilenames, packageInfo.get());
 
@@ -388,0 +318,0 @@ return parsedFiles.length;

lib/parser.js

@@ -5,2 +5,3 @@ var fs = require("fs");
 var _ = require("underscore");
+var markdown = require("marked");
 
@@ -21,2 +22,5 @@ var app = {};
 
+	// Markdown settings
+	markdown.setOptions(app.options.marked);
+
 	// Parser laden
@@ -121,2 +125,21 @@ var parsers = Object.keys(app.parsers);
 					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
+					}
 				}
@@ -310,2 +333,9 @@ catch(e)
 
+		case ".pm":
+			// Find document blocks between "#**" and "#*"
+			docBlocksRegExp = /#\*\*\uffff?(.+?)#\*/g;
+			// Remove not needed " # " and "	" (tabs) at the beginning
+			inlineRegExp = /^(\s+)?(#)[ ]?/gm;
+			break;
+
 		default:
@@ -312,0 +342,0 @@ // Find document blocks between "/**" and "*/"

lib/plugins/parser_api_define_permission.js

@@ -42,3 +42,4 @@ function parse(content)
 	parse: parse,
-	pushTo: pushTo
+	pushTo: pushTo,
+	markdownFields: [ "description" ]
 };

lib/plugins/parser_api_description.js

@@ -22,3 +22,4 @@ function parse(content)
 	parse: parse,
-	pushTo: pushTo
+	pushTo: pushTo,
+	markdownFields: [ "description" ]
 };

lib/plugins/parser_api_error.js

@@ -19,3 +19,4 @@ // Same as @apiparam
 	parse: parse,
-	pushTo: pushTo
+	pushTo: pushTo,
+	markdownFields: [ "description" ]
 };

lib/plugins/parser_api_group_description.js

@@ -22,3 +22,4 @@ function parse(content)
   parse: parse,
-  pushTo: pushTo
+  pushTo: pushTo,
+	markdownFields: [ "groupDescription" ]
 };

lib/plugins/parser_api_header.js

@@ -19,3 +19,4 @@ // Same as @apiParam
 	parse: parse,
-	pushTo: pushTo
+	pushTo: pushTo,
+	markdownFields: [ "description" ]
 };

lib/plugins/parser_api_info.js

@@ -19,3 +19,4 @@ // Same as @apiparam
 	parse: parse,
-	pushTo: pushTo
+	pushTo: pushTo,
+	markdownFields: [ "description" ]
 };

lib/plugins/parser_api_param.js

@@ -106,3 +106,4 @@ var group = "";
 	pushTo: pushTo,
-	getGroup: getGroup
+	getGroup: getGroup,
+	markdownFields: [ "description" ]
 };

lib/plugins/parser_api_success.js

@@ -19,3 +19,4 @@ // Same as @apiparam
 	parse: parse,
-	pushTo: pushTo
+	pushTo: pushTo,
+	markdownFields: [ "description" ]
 };

package.json

 {
   "name": "apidoc",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "RESTful web API Documentation Generator",
@@ -5,0 +5,0 @@ "author": "Peter Rottmann <[e-mail]>",

README.md

@@ -1,5 +0,7 @@
-# apiDoc 0.5.x
+# apiDoc 0.6.x
 
 Generates a RESTful web API Documentation.
 
+### **Important** [markdown](https://help.github.com/articles/markdown-basics) for all description fields is now enabled!
+
 Documentation at [apidocjs.com](http://apidocjs.com).
@@ -61,2 +63,10 @@
 
+ * **Perl**
+
+   ```perl
+   #**
+   # This is a comment.
+   #*
+   ```
+
  * **Python**
@@ -63,0 +73,0 @@

template/main.js

@@ -30,3 +30,4 @@ require.config({
 	},
-	urlArgs: "v=" + (new Date()).getTime()
+	urlArgs: "v=" + (new Date()).getTime(),
+	waitSeconds: 1
 });
@@ -58,4 +59,11 @@
 	var templateSidenav        = Handlebars.compile( $("#template-sidenav").html() );
-	
+
 	/**
+	 * apiProject defaults.
+	 */
+	if( ! apiProject.template) apiProject.template = {};
+	if(apiProject.template.withCompare == null) apiProject.template.withCompare = true;
+	if(apiProject.template.withGenerator == null) apiProject.template.withGenerator = true;
+
+	/**
 	 * Data transform.
@@ -197,2 +205,7 @@ */
 	/**
+	 * Remove loader.
+	 */
+	$("#loader").remove();
+
+	/**
 	 * Render Sidenav.
@@ -260,7 +273,3 @@ */
 
-				if(entry.header && entry.header.fields) fields._hasTypeInHeaderFields = _hasTypeInFields(entry.header.fields);
-				if(entry.parameter && entry.parameter.fields) fields._hasTypeInParameterFields = _hasTypeInFields(entry.parameter.fields);
-				if(entry.error && entry.error.fields) fields._hasTypeInErrorFields = _hasTypeInFields(entry.error.fields);
-				if(entry.success && entry.success.fields) fields._hasTypeInSuccessFields = _hasTypeInFields(entry.success.fields);
-				if(entry.info && entry.info.fields) fields._hasTypeInInfoFields = _hasTypeInFields(entry.info.fields);
+				addArticleSettings(fields, entry);
 
@@ -270,5 +279,2 @@ // TODO: make groupDescription compareable with older versions (not important for the moment).
 
-				// Add endpoint URL
-				if(apiProject.url) fields.article.url = apiProject.url + fields.article.url; 
-
 				articles.push({
@@ -347,12 +353,15 @@ article: templateArticle(fields),
 		$("#sidenav li").removeClass("is-new");
-		$("#sidenav li[data-version=\"" + version + "\"]").each(function(){
-			var group = $(this).data("group");
-			var name = $(this).data("name");
-			var length = $("#sidenav li[data-group=\"" + group + "\"][data-name=\"" + name + "\"]").length;
-			var index  = $("#sidenav li[data-group=\"" + group + "\"][data-name=\"" + name + "\"]").index($(this));
-			if(length === 1 || index === (length - 1))
-			{
-				$(this).addClass("is-new");
-			}
-		});
+		if(apiProject.template.withCompare)
+		{
+			$("#sidenav li[data-version=\"" + version + "\"]").each(function(){
+				var group = $(this).data("group");
+				var name = $(this).data("name");
+				var length = $("#sidenav li[data-group=\"" + group + "\"][data-name=\"" + name + "\"]").length;
+				var index  = $("#sidenav li[data-group=\"" + group + "\"][data-name=\"" + name + "\"]").index($(this));
+				if(length === 1 || index === (length - 1))
+				{
+					$(this).addClass("is-new");
+				}
+			});
+		}
 	} // initDynamic
@@ -531,2 +540,20 @@ initDynamic();
 	/**
+	 * Add article settings.
+	 */
+	function addArticleSettings(fields, entry)
+	{
+		if(entry.header && entry.header.fields) fields._hasTypeInHeaderFields = _hasTypeInFields(entry.header.fields);
+		if(entry.parameter && entry.parameter.fields) fields._hasTypeInParameterFields = _hasTypeInFields(entry.parameter.fields);
+		if(entry.error && entry.error.fields)         fields._hasTypeInErrorFields = _hasTypeInFields(entry.error.fields);
+		if(entry.success && entry.success.fields)     fields._hasTypeInSuccessFields = _hasTypeInFields(entry.success.fields);
+		if(entry.info && entry.info.fields)           fields._hasTypeInInfoFields = _hasTypeInFields(entry.info.fields);
+
+		// Add prefix URL for endpoint
+		if(apiProject.url) fields.article.url = apiProject.url + fields.article.url; 
+
+		// Add template settings
+		fields.template = apiProject.template;
+	} // addArticleSettings
+
+	/**
 	 * Render an Article.
@@ -545,6 +572,3 @@ */
 
-		if(entry.parameter && entry.parameter.fields) fields._hasTypeInParameterFields = _hasTypeInFields(entry.parameter.fields);
-		if(entry.error && entry.error.fields) fields._hasTypeInErrorFields = _hasTypeInFields(entry.error.fields);
-		if(entry.success && entry.success.fields) fields._hasTypeInSuccessFields = _hasTypeInFields(entry.success.fields);
-		if(entry.info && entry.info.fields) fields._hasTypeInInfoFields = _hasTypeInFields(entry.info.fields);
+		addArticleSettings(fields, entry);
 
@@ -573,2 +597,2 @@ return templateArticle(fields);
 	} // resetArticle
-});
+});

test/fixtures/api_data.js

@@ -9,3 +9,3 @@ define({ api: [
     "version": "0.1.0",
-    "description": "Use of multiple ErrorStructures.",
+    "description": "<p>Use of multiple ErrorStructures.</p>",
     "error": {
@@ -18,3 +18,3 @@ "fields": {
             "optional": false,
-            "description": "This is Error 3 (local)."
+            "description": "<p>This is Error 3 (local).</p>"
           },
@@ -25,3 +25,3 @@ {
             "optional": false,
-            "description": "This is Error 1."
+            "description": "<p>This is Error 1.</p>"
           },
@@ -32,3 +32,3 @@ {
             "optional": false,
-            "description": "This is Error 2."
+            "description": "<p>This is Error 2.</p>"
           }
@@ -47,3 +47,3 @@ ]
     "version": "0.1.0",
-    "description": "Use of Title and Structures in the same block.",
+    "description": "<p>Use of Title and Structures in the same block.</p>",
     "success": {
@@ -56,3 +56,3 @@ "fields": {
             "optional": false,
-            "description": "Successfully deleted."
+            "description": "<p>Successfully deleted.</p>"
           }
@@ -69,3 +69,3 @@ ]
             "optional": false,
-            "description": "This is Error 3 (local)."
+            "description": "<p>This is Error 3 (local).</p>"
           },
@@ -76,3 +76,3 @@ {
             "optional": false,
-            "description": "This is Error 1."
+            "description": "<p>This is Error 1.</p>"
           }
@@ -90,3 +90,3 @@ ]
     "group": "Group",
-    "groupDescription": "This is a Group Description.\nMulitline capable.",
+    "groupDescription": "<p>This is a Group Description.Mulitline capable.</p>",
     "version": "0.5.0",
@@ -102,3 +102,3 @@ "filename": "test/fixtures/example/group.js"
     "version": "0.1.0",
-    "description": "Title and Grouping of param, success and error",
+    "description": "<p>Title and Grouping of param, success and error</p>",
     "parameter": {
@@ -112,3 +112,3 @@ "fields": {
             "optional": false,
-            "description": "No Group, automatically set Group to \"Parameter\""
+            "description": "<p>No Group, automatically set Group to &quot;Parameter&quot;</p>"
           }
@@ -122,3 +122,3 @@ ],
             "optional": false,
-            "description": "Group \"login\""
+            "description": "<p>Group &quot;login&quot;</p>"
           },
@@ -131,3 +131,3 @@ {
             "optional": true,
-            "description": "Group \"login\" with default Value"
+            "description": "<p>Group &quot;login&quot; with default Value</p>"
           }
@@ -145,3 +145,3 @@ ]
             "optional": false,
-            "description": "Group \"201\""
+            "description": "<p>Group &quot;201&quot;</p>"
           },
@@ -154,3 +154,3 @@ {
             "optional": true,
-            "description": "Group \"201\" with default Value"
+            "description": "<p>Group &quot;201&quot; with default Value</p>"
           }
@@ -164,3 +164,3 @@ ],
             "optional": false,
-            "description": "No Group, automatically set \"Success 200\""
+            "description": "<p>No Group, automatically set &quot;Success 200&quot;</p>"
           }
@@ -178,3 +178,3 @@ ]
             "optional": false,
-            "description": "Group \"400\""
+            "description": "<p>Group &quot;400&quot;</p>"
           }
@@ -188,3 +188,3 @@ ],
             "optional": false,
-            "description": "Group \"401\""
+            "description": "<p>Group &quot;401&quot;</p>"
           }
@@ -198,3 +198,3 @@ ],
             "optional": false,
-            "description": "No Group automatically set \"Error 4xx\""
+            "description": "<p>No Group automatically set &quot;Error 4xx&quot;</p>"
           }
@@ -213,3 +213,3 @@ ]
     "version": "0.5.0",
-    "description": "Test for @apiHeader (same as @apiParam)",
+    "description": "<p>Test for @apiHeader (same as @apiParam)</p>",
     "header": {
@@ -223,3 +223,3 @@ "fields": {
             "optional": false,
-            "description": "Parameter with type and description."
+            "description": "<p>Parameter with type and description.</p>"
           },
@@ -239,3 +239,3 @@ {
             "optional": true,
-            "description": "Parameter with type, description and default value."
+            "description": "<p>Parameter with type, description and default value.</p>"
           },
@@ -254,3 +254,3 @@ {
             "optional": false,
-            "description": "Basic Parameter with description."
+            "description": "<p>Basic Parameter with description.</p>"
           },
@@ -268,3 +268,3 @@ {
             "optional": true,
-            "description": "Basic Parameter with description and default value."
+            "description": "<p>Basic Parameter with description and default value.</p>"
           },
@@ -282,3 +282,3 @@ {
             "optional": true,
-            "description": "Optional basic Parameter with description."
+            "description": "<p>Optional basic Parameter with description.</p>"
           },
@@ -296,3 +296,3 @@ {
             "optional": true,
-            "description": "Optional basic Parameter with description and default value."
+            "description": "<p>Optional basic Parameter with description and default value.</p>"
           },
@@ -311,3 +311,3 @@ {
             "optional": true,
-            "description": "Optional Parameter with type and description."
+            "description": "<p>Optional Parameter with type and description.</p>"
           },
@@ -327,3 +327,3 @@ {
             "optional": true,
-            "description": "Optional Parameter with type, description and default value."
+            "description": "<p>Optional Parameter with type, description and default value.</p>"
           },
@@ -350,3 +350,3 @@ {
     "version": "0.5.0",
-    "description": "Usage of @headerExample.",
+    "description": "<p>Usage of @headerExample.</p>",
     "header": {
@@ -369,3 +369,3 @@ "examples": [
     "version": "0.5.0",
-    "description": "Usage of @headerTitle.",
+    "description": "<p>Usage of @headerTitle.</p>",
     "header": {
@@ -378,3 +378,3 @@ "fields": {
             "optional": false,
-            "description": "The authorization code."
+            "description": "<p>The authorization code.</p>"
           },
@@ -386,3 +386,3 @@ {
             "optional": false,
-            "description": "Some text."
+            "description": "<p>Some text.</p>"
           }
@@ -401,3 +401,3 @@ ]
     "version": "0.5.0",
-    "description": "Use of multiple HeaderStructures.",
+    "description": "<p>Use of multiple HeaderStructures.</p>",
     "header": {
@@ -410,3 +410,3 @@ "fields": {
             "optional": false,
-            "description": "This is Header 3 (local)."
+            "description": "<p>This is Header 3 (local).</p>"
           },
@@ -417,3 +417,3 @@ {
             "optional": false,
-            "description": "This is Header 1."
+            "description": "<p>This is Header 1.</p>"
           },
@@ -424,3 +424,3 @@ {
             "optional": false,
-            "description": "This is Header 2."
+            "description": "<p>This is Header 2.</p>"
           }
@@ -439,3 +439,3 @@ ]
     "version": "0.4.0",
-    "description": "Test for CoffeeScript Comment-Syntax.",
+    "description": "<p>Test for CoffeeScript Comment-Syntax.</p>",
     "filename": "test/fixtures/example/language.coffee"
@@ -480,3 +480,3 @@ },
     "version": "0.4.0",
-    "description": "Test for Erlang Comment-Syntax.",
+    "description": "<p>Test for Erlang Comment-Syntax.</p>",
     "filename": "test/fixtures/example/language.erl"
@@ -521,3 +521,3 @@ },
     "version": "0.4.0",
-    "description": "Test for JavaScript Comment-Syntax.",
+    "description": "<p>Test for JavaScript Comment-Syntax.</p>",
     "filename": "test/fixtures/example/language.js"
@@ -557,2 +557,42 @@ },
     "type": "get",
+    "url": "/language/perl",
+    "title": "Perl",
+    "name": "GetLanguagePerl",
+    "group": "Language",
+    "version": "0.4.0",
+    "description": "<p>Test for Perl Comment-Syntax.</p>",
+    "filename": "test/fixtures/example/language.pm"
+  },
+  {
+    "type": "get",
+    "url": "/language/perl/indented1",
+    "title": "Perl indented 1",
+    "name": "GetLanguagePerlIndented1",
+    "group": "Language",
+    "version": "0.4.0",
+    "examples": [
+      {
+        "title": "Test for indented comment.",
+        "content": "This is example line 2.\nThis is example line 3.\n\tLine 4 indented (with tab at beginning).\nLine 5 indented.\nThis is example line 6.\n"
+      }
+    ],
+    "filename": "test/fixtures/example/language.pm"
+  },
+  {
+    "type": "get",
+    "url": "/language/perl/indented2",
+    "title": "Perl indented 2",
+    "name": "GetLanguagePerlIndented2",
+    "group": "Language",
+    "version": "0.4.0",
+    "examples": [
+      {
+        "title": "Test for indented comment.",
+        "content": "This is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n"
+      }
+    ],
+    "filename": "test/fixtures/example/language.pm"
+  },
+  {
+    "type": "get",
     "url": "/language/python",
@@ -563,3 +603,3 @@ "title": "Python",
     "version": "0.4.0",
-    "description": "Test for Python Comment-Syntax.",
+    "description": "<p>Test for Python Comment-Syntax.</p>",
     "filename": "test/fixtures/example/language.py"
@@ -604,3 +644,3 @@ },
     "version": "0.4.0",
-    "description": "Test for Ruby Comment-Syntax.",
+    "description": "<p>Test for Ruby Comment-Syntax.</p>",
     "filename": "test/fixtures/example/language.rb"
@@ -640,2 +680,25 @@ },
     "type": "get",
+    "url": "/markdown/:id",
+    "title": "Markdown",
+    "name": "GetMarkdown",
+    "group": "Markdown",
+    "version": "0.6.0",
+    "description": "<p>Enable markdown for all description fields.</p><p>This <strong>text</strong> is in a <strong>separate</strong> p.</p><ul><li>List 1</li><li>List 2</li></ul><p>Multiline markdown text, output in one line.</p>",
+    "parameter": {
+      "fields": {
+        "Parameter": [
+          {
+            "group": "Parameter",
+            "type": "String",
+            "field": "param1",
+            "optional": false,
+            "description": "<p>This is a markdown <strong>apiParam</strong></p><p>Separate line.</p>"
+          }
+        ]
+      }
+    },
+    "filename": "test/fixtures/example/markdown.js"
+  },
+  {
+    "type": "get",
     "url": "/param/:id",
@@ -646,3 +709,3 @@ "title": "Parameters",
     "version": "0.1.1",
-    "description": "Parameters and different Versions: 0.1.1",
+    "description": "<p>Parameters and different Versions: 0.1.1</p>",
     "parameter": {
@@ -656,3 +719,3 @@ "fields": {
             "optional": false,
-            "description": "Parameter with type and description."
+            "description": "<p>Parameter with type and description.</p>"
           },
@@ -672,3 +735,3 @@ {
             "optional": true,
-            "description": "Parameter with type, description and default value."
+            "description": "<p>Parameter with type, description and default value.</p>"
           },
@@ -687,3 +750,3 @@ {
             "optional": false,
-            "description": "Basic Parameter with description."
+            "description": "<p>Basic Parameter with description.</p>"
           },
@@ -701,3 +764,3 @@ {
             "optional": true,
-            "description": "Basic Parameter with description and default value."
+            "description": "<p>Basic Parameter with description and default value.</p>"
           },
@@ -715,3 +778,3 @@ {
             "optional": true,
-            "description": "Optional basic Parameter with description."
+            "description": "<p>Optional basic Parameter with description.</p>"
           },
@@ -729,3 +792,3 @@ {
             "optional": true,
-            "description": "Optional basic Parameter with description and default value."
+            "description": "<p>Optional basic Parameter with description and default value.</p>"
           },
@@ -744,3 +807,3 @@ {
             "optional": true,
-            "description": "Optional Parameter with type and description."
+            "description": "<p>Optional Parameter with type and description.</p>"
           },
@@ -760,3 +823,3 @@ {
             "optional": true,
-            "description": "Optional Parameter with type, description and default value."
+            "description": "<p>Optional Parameter with type, description and default value.</p>"
           },
@@ -783,3 +846,3 @@ {
     "version": "0.1.0",
-    "description": "Parameters and different Versions: 0.1.0",
+    "description": "<p>Parameters and different Versions: 0.1.0</p>",
     "parameter": {
@@ -793,3 +856,3 @@ "fields": {
             "optional": false,
-            "description": "This param is removed in 0.1.1."
+            "description": "<p>This param is removed in 0.1.1.</p>"
           },
@@ -801,3 +864,3 @@ {
             "optional": false,
-            "description": "This is an old text."
+            "description": "<p>This is an old text.</p>"
           },
@@ -817,3 +880,3 @@ {
             "optional": true,
-            "description": "Parameter with type, description and default value."
+            "description": "<p>Parameter with type, description and default value.</p>"
           },
@@ -832,3 +895,3 @@ {
             "optional": false,
-            "description": "Basic Parameter with description."
+            "description": "<p>Basic Parameter with description.</p>"
           },
@@ -846,3 +909,3 @@ {
             "optional": true,
-            "description": "Basic Parameter with description and default value."
+            "description": "<p>Basic Parameter with description and default value.</p>"
           },
@@ -860,3 +923,3 @@ {
             "optional": true,
-            "description": "Optional basic Parameter with description."
+            "description": "<p>Optional basic Parameter with description.</p>"
           },
@@ -874,3 +937,3 @@ {
             "optional": true,
-            "description": "Optional basic Parameter with description and default value."
+            "description": "<p>Optional basic Parameter with description and default value.</p>"
           },
@@ -889,3 +952,3 @@ {
             "optional": true,
-            "description": "Optional Parameter with type and description."
+            "description": "<p>Optional Parameter with type and description.</p>"
           },
@@ -905,3 +968,3 @@ {
             "optional": true,
-            "description": "Optional Parameter with type, description and default value."
+            "description": "<p>Optional Parameter with type, description and default value.</p>"
           },
@@ -928,3 +991,3 @@ {
     "version": "0.1.0",
-    "description": "Use of multiple Structures.",
+    "description": "<p>Use of multiple Structures.</p>",
     "parameter": {
@@ -937,3 +1000,3 @@ "fields": {
             "optional": false,
-            "description": "This is Field 3 (local)."
+            "description": "<p>This is Field 3 (local).</p>"
           },
@@ -944,3 +1007,3 @@ {
             "optional": false,
-            "description": "This is Field 1."
+            "description": "<p>This is Field 1.</p>"
           },
@@ -951,3 +1014,3 @@ {
             "optional": false,
-            "description": "This is Field 2."
+            "description": "<p>This is Field 2.</p>"
           }
@@ -966,3 +1029,3 @@ ]
     "version": "0.1.0",
-    "description": "Use of multiple SuccessStructures.",
+    "description": "<p>Use of multiple SuccessStructures.</p>",
     "success": {
@@ -975,3 +1038,3 @@ "fields": {
             "optional": false,
-            "description": "This is Success 3 (local)."
+            "description": "<p>This is Success 3 (local).</p>"
           },
@@ -982,3 +1045,3 @@ {
             "optional": false,
-            "description": "This is Success 1."
+            "description": "<p>This is Success 1.</p>"
           },
@@ -989,3 +1052,3 @@ {
             "optional": false,
-            "description": "This is Success 2."
+            "description": "<p>This is Success 2.</p>"
           }
@@ -1005,3 +1068,3 @@ ]
             "optional": false,
-            "description": "This is Error 1."
+            "description": "<p>This is Error 1.</p>"
           }
@@ -1025,3 +1088,3 @@ ]
             "optional": false,
-            "description": "This is Error 2."
+            "description": "<p>This is Error 2.</p>"
           }
@@ -1045,3 +1108,3 @@ ]
             "optional": false,
-            "description": "This is Header 2."
+            "description": "<p>This is Header 2.</p>"
           }
@@ -1065,3 +1128,3 @@ ]
             "optional": false,
-            "description": "This is Header 1."
+            "description": "<p>This is Header 1.</p>"
           }
@@ -1085,3 +1148,3 @@ ]
             "optional": false,
-            "description": "This is Field 1."
+            "description": "<p>This is Field 1.</p>"
           }
@@ -1105,3 +1168,3 @@ ]
             "optional": false,
-            "description": "This is Field 2."
+            "description": "<p>This is Field 2.</p>"
           }
@@ -1125,3 +1188,3 @@ ]
             "optional": false,
-            "description": "This is Success 1."
+            "description": "<p>This is Success 1.</p>"
           }
@@ -1145,3 +1208,3 @@ ]
             "optional": false,
-            "description": "This is Success 2."
+            "description": "<p>This is Success 2.</p>"
           }
@@ -1165,3 +1228,3 @@ ]
             "optional": false,
-            "description": "This is Error 1."
+            "description": "<p>This is Error 1.</p>"
           }
@@ -1168,0 +1231,0 @@ ]

test/fixtures/api_data.json

@@ -9,3 +9,3 @@ [
     "version": "0.1.0",
-    "description": "Use of multiple ErrorStructures.",
+    "description": "<p>Use of multiple ErrorStructures.</p>",
     "error": {
@@ -18,3 +18,3 @@ "fields": {
             "optional": false,
-            "description": "This is Error 3 (local)."
+            "description": "<p>This is Error 3 (local).</p>"
           },
@@ -25,3 +25,3 @@ {
             "optional": false,
-            "description": "This is Error 1."
+            "description": "<p>This is Error 1.</p>"
           },
@@ -32,3 +32,3 @@ {
             "optional": false,
-            "description": "This is Error 2."
+            "description": "<p>This is Error 2.</p>"
           }
@@ -47,3 +47,3 @@ ]
     "version": "0.1.0",
-    "description": "Use of Title and Structures in the same block.",
+    "description": "<p>Use of Title and Structures in the same block.</p>",
     "success": {
@@ -56,3 +56,3 @@ "fields": {
             "optional": false,
-            "description": "Successfully deleted."
+            "description": "<p>Successfully deleted.</p>"
           }
@@ -69,3 +69,3 @@ ]
             "optional": false,
-            "description": "This is Error 3 (local)."
+            "description": "<p>This is Error 3 (local).</p>"
           },
@@ -76,3 +76,3 @@ {
             "optional": false,
-            "description": "This is Error 1."
+            "description": "<p>This is Error 1.</p>"
           }
@@ -90,3 +90,3 @@ ]
     "group": "Group",
-    "groupDescription": "This is a Group Description.\nMulitline capable.",
+    "groupDescription": "<p>This is a Group Description.Mulitline capable.</p>",
     "version": "0.5.0",
@@ -102,3 +102,3 @@ "filename": "test/fixtures/example/group.js"
     "version": "0.1.0",
-    "description": "Title and Grouping of param, success and error",
+    "description": "<p>Title and Grouping of param, success and error</p>",
     "parameter": {
@@ -112,3 +112,3 @@ "fields": {
             "optional": false,
-            "description": "No Group, automatically set Group to \"Parameter\""
+            "description": "<p>No Group, automatically set Group to &quot;Parameter&quot;</p>"
           }
@@ -122,3 +122,3 @@ ],
             "optional": false,
-            "description": "Group \"login\""
+            "description": "<p>Group &quot;login&quot;</p>"
           },
@@ -131,3 +131,3 @@ {
             "optional": true,
-            "description": "Group \"login\" with default Value"
+            "description": "<p>Group &quot;login&quot; with default Value</p>"
           }
@@ -145,3 +145,3 @@ ]
             "optional": false,
-            "description": "Group \"201\""
+            "description": "<p>Group &quot;201&quot;</p>"
           },
@@ -154,3 +154,3 @@ {
             "optional": true,
-            "description": "Group \"201\" with default Value"
+            "description": "<p>Group &quot;201&quot; with default Value</p>"
           }
@@ -164,3 +164,3 @@ ],
             "optional": false,
-            "description": "No Group, automatically set \"Success 200\""
+            "description": "<p>No Group, automatically set &quot;Success 200&quot;</p>"
           }
@@ -178,3 +178,3 @@ ]
             "optional": false,
-            "description": "Group \"400\""
+            "description": "<p>Group &quot;400&quot;</p>"
           }
@@ -188,3 +188,3 @@ ],
             "optional": false,
-            "description": "Group \"401\""
+            "description": "<p>Group &quot;401&quot;</p>"
           }
@@ -198,3 +198,3 @@ ],
             "optional": false,
-            "description": "No Group automatically set \"Error 4xx\""
+            "description": "<p>No Group automatically set &quot;Error 4xx&quot;</p>"
           }
@@ -213,3 +213,3 @@ ]
     "version": "0.5.0",
-    "description": "Test for @apiHeader (same as @apiParam)",
+    "description": "<p>Test for @apiHeader (same as @apiParam)</p>",
     "header": {
@@ -223,3 +223,3 @@ "fields": {
             "optional": false,
-            "description": "Parameter with type and description."
+            "description": "<p>Parameter with type and description.</p>"
           },
@@ -239,3 +239,3 @@ {
             "optional": true,
-            "description": "Parameter with type, description and default value."
+            "description": "<p>Parameter with type, description and default value.</p>"
           },
@@ -254,3 +254,3 @@ {
             "optional": false,
-            "description": "Basic Parameter with description."
+            "description": "<p>Basic Parameter with description.</p>"
           },
@@ -268,3 +268,3 @@ {
             "optional": true,
-            "description": "Basic Parameter with description and default value."
+            "description": "<p>Basic Parameter with description and default value.</p>"
           },
@@ -282,3 +282,3 @@ {
             "optional": true,
-            "description": "Optional basic Parameter with description."
+            "description": "<p>Optional basic Parameter with description.</p>"
           },
@@ -296,3 +296,3 @@ {
             "optional": true,
-            "description": "Optional basic Parameter with description and default value."
+            "description": "<p>Optional basic Parameter with description and default value.</p>"
           },
@@ -311,3 +311,3 @@ {
             "optional": true,
-            "description": "Optional Parameter with type and description."
+            "description": "<p>Optional Parameter with type and description.</p>"
           },
@@ -327,3 +327,3 @@ {
             "optional": true,
-            "description": "Optional Parameter with type, description and default value."
+            "description": "<p>Optional Parameter with type, description and default value.</p>"
           },
@@ -350,3 +350,3 @@ {
     "version": "0.5.0",
-    "description": "Usage of @headerExample.",
+    "description": "<p>Usage of @headerExample.</p>",
     "header": {
@@ -369,3 +369,3 @@ "examples": [
     "version": "0.5.0",
-    "description": "Usage of @headerTitle.",
+    "description": "<p>Usage of @headerTitle.</p>",
     "header": {
@@ -378,3 +378,3 @@ "fields": {
             "optional": false,
-            "description": "The authorization code."
+            "description": "<p>The authorization code.</p>"
           },
@@ -386,3 +386,3 @@ {
             "optional": false,
-            "description": "Some text."
+            "description": "<p>Some text.</p>"
           }
@@ -401,3 +401,3 @@ ]
     "version": "0.5.0",
-    "description": "Use of multiple HeaderStructures.",
+    "description": "<p>Use of multiple HeaderStructures.</p>",
     "header": {
@@ -410,3 +410,3 @@ "fields": {
             "optional": false,
-            "description": "This is Header 3 (local)."
+            "description": "<p>This is Header 3 (local).</p>"
           },
@@ -417,3 +417,3 @@ {
             "optional": false,
-            "description": "This is Header 1."
+            "description": "<p>This is Header 1.</p>"
           },
@@ -424,3 +424,3 @@ {
             "optional": false,
-            "description": "This is Header 2."
+            "description": "<p>This is Header 2.</p>"
           }
@@ -439,3 +439,3 @@ ]
     "version": "0.4.0",
-    "description": "Test for CoffeeScript Comment-Syntax.",
+    "description": "<p>Test for CoffeeScript Comment-Syntax.</p>",
     "filename": "test/fixtures/example/language.coffee"
@@ -480,3 +480,3 @@ },
     "version": "0.4.0",
-    "description": "Test for Erlang Comment-Syntax.",
+    "description": "<p>Test for Erlang Comment-Syntax.</p>",
     "filename": "test/fixtures/example/language.erl"
@@ -521,3 +521,3 @@ },
     "version": "0.4.0",
-    "description": "Test for JavaScript Comment-Syntax.",
+    "description": "<p>Test for JavaScript Comment-Syntax.</p>",
     "filename": "test/fixtures/example/language.js"
@@ -557,2 +557,42 @@ },
     "type": "get",
+    "url": "/language/perl",
+    "title": "Perl",
+    "name": "GetLanguagePerl",
+    "group": "Language",
+    "version": "0.4.0",
+    "description": "<p>Test for Perl Comment-Syntax.</p>",
+    "filename": "test/fixtures/example/language.pm"
+  },
+  {
+    "type": "get",
+    "url": "/language/perl/indented1",
+    "title": "Perl indented 1",
+    "name": "GetLanguagePerlIndented1",
+    "group": "Language",
+    "version": "0.4.0",
+    "examples": [
+      {
+        "title": "Test for indented comment.",
+        "content": "This is example line 2.\nThis is example line 3.\n\tLine 4 indented (with tab at beginning).\nLine 5 indented.\nThis is example line 6.\n"
+      }
+    ],
+    "filename": "test/fixtures/example/language.pm"
+  },
+  {
+    "type": "get",
+    "url": "/language/perl/indented2",
+    "title": "Perl indented 2",
+    "name": "GetLanguagePerlIndented2",
+    "group": "Language",
+    "version": "0.4.0",
+    "examples": [
+      {
+        "title": "Test for indented comment.",
+        "content": "This is example line 2.\nThis is example line 3.\n    Line 4 indented (with tab at beginning).\n   Line 5 indented.\nThis is example line 6.\n"
+      }
+    ],
+    "filename": "test/fixtures/example/language.pm"
+  },
+  {
+    "type": "get",
     "url": "/language/python",
@@ -563,3 +603,3 @@ "title": "Python",
     "version": "0.4.0",
-    "description": "Test for Python Comment-Syntax.",
+    "description": "<p>Test for Python Comment-Syntax.</p>",
     "filename": "test/fixtures/example/language.py"
@@ -604,3 +644,3 @@ },
     "version": "0.4.0",
-    "description": "Test for Ruby Comment-Syntax.",
+    "description": "<p>Test for Ruby Comment-Syntax.</p>",
     "filename": "test/fixtures/example/language.rb"
@@ -640,2 +680,25 @@ },
     "type": "get",
+    "url": "/markdown/:id",
+    "title": "Markdown",
+    "name": "GetMarkdown",
+    "group": "Markdown",
+    "version": "0.6.0",
+    "description": "<p>Enable markdown for all description fields.</p><p>This <strong>text</strong> is in a <strong>separate</strong> p.</p><ul><li>List 1</li><li>List 2</li></ul><p>Multiline markdown text, output in one line.</p>",
+    "parameter": {
+      "fields": {
+        "Parameter": [
+          {
+            "group": "Parameter",
+            "type": "String",
+            "field": "param1",
+            "optional": false,
+            "description": "<p>This is a markdown <strong>apiParam</strong></p><p>Separate line.</p>"
+          }
+        ]
+      }
+    },
+    "filename": "test/fixtures/example/markdown.js"
+  },
+  {
+    "type": "get",
     "url": "/param/:id",
@@ -646,3 +709,3 @@ "title": "Parameters",
     "version": "0.1.1",
-    "description": "Parameters and different Versions: 0.1.1",
+    "description": "<p>Parameters and different Versions: 0.1.1</p>",
     "parameter": {
@@ -656,3 +719,3 @@ "fields": {
             "optional": false,
-            "description": "Parameter with type and description."
+            "description": "<p>Parameter with type and description.</p>"
           },
@@ -672,3 +735,3 @@ {
             "optional": true,
-            "description": "Parameter with type, description and default value."
+            "description": "<p>Parameter with type, description and default value.</p>"
           },
@@ -687,3 +750,3 @@ {
             "optional": false,
-            "description": "Basic Parameter with description."
+            "description": "<p>Basic Parameter with description.</p>"
           },
@@ -701,3 +764,3 @@ {
             "optional": true,
-            "description": "Basic Parameter with description and default value."
+            "description": "<p>Basic Parameter with description and default value.</p>"
           },
@@ -715,3 +778,3 @@ {
             "optional": true,
-            "description": "Optional basic Parameter with description."
+            "description": "<p>Optional basic Parameter with description.</p>"
           },
@@ -729,3 +792,3 @@ {
             "optional": true,
-            "description": "Optional basic Parameter with description and default value."
+            "description": "<p>Optional basic Parameter with description and default value.</p>"
           },
@@ -744,3 +807,3 @@ {
             "optional": true,
-            "description": "Optional Parameter with type and description."
+            "description": "<p>Optional Parameter with type and description.</p>"
           },
@@ -760,3 +823,3 @@ {
             "optional": true,
-            "description": "Optional Parameter with type, description and default value."
+            "description": "<p>Optional Parameter with type, description and default value.</p>"
           },
@@ -783,3 +846,3 @@ {
     "version": "0.1.0",
-    "description": "Parameters and different Versions: 0.1.0",
+    "description": "<p>Parameters and different Versions: 0.1.0</p>",
     "parameter": {
@@ -793,3 +856,3 @@ "fields": {
             "optional": false,
-            "description": "This param is removed in 0.1.1."
+            "description": "<p>This param is removed in 0.1.1.</p>"
           },
@@ -801,3 +864,3 @@ {
             "optional": false,
-            "description": "This is an old text."
+            "description": "<p>This is an old text.</p>"
           },
@@ -817,3 +880,3 @@ {
             "optional": true,
-            "description": "Parameter with type, description and default value."
+            "description": "<p>Parameter with type, description and default value.</p>"
           },
@@ -832,3 +895,3 @@ {
             "optional": false,
-            "description": "Basic Parameter with description."
+            "description": "<p>Basic Parameter with description.</p>"
           },
@@ -846,3 +909,3 @@ {
             "optional": true,
-            "description": "Basic Parameter with description and default value."
+            "description": "<p>Basic Parameter with description and default value.</p>"
           },
@@ -860,3 +923,3 @@ {
             "optional": true,
-            "description": "Optional basic Parameter with description."
+            "description": "<p>Optional basic Parameter with description.</p>"
           },
@@ -874,3 +937,3 @@ {
             "optional": true,
-            "description": "Optional basic Parameter with description and default value."
+            "description": "<p>Optional basic Parameter with description and default value.</p>"
           },
@@ -889,3 +952,3 @@ {
             "optional": true,
-            "description": "Optional Parameter with type and description."
+            "description": "<p>Optional Parameter with type and description.</p>"
           },
@@ -905,3 +968,3 @@ {
             "optional": true,
-            "description": "Optional Parameter with type, description and default value."
+            "description": "<p>Optional Parameter with type, description and default value.</p>"
           },
@@ -928,3 +991,3 @@ {
     "version": "0.1.0",
-    "description": "Use of multiple Structures.",
+    "description": "<p>Use of multiple Structures.</p>",
     "parameter": {
@@ -937,3 +1000,3 @@ "fields": {
             "optional": false,
-            "description": "This is Field 3 (local)."
+            "description": "<p>This is Field 3 (local).</p>"
           },
@@ -944,3 +1007,3 @@ {
             "optional": false,
-            "description": "This is Field 1."
+            "description": "<p>This is Field 1.</p>"
           },
@@ -951,3 +1014,3 @@ {
             "optional": false,
-            "description": "This is Field 2."
+            "description": "<p>This is Field 2.</p>"
           }
@@ -966,3 +1029,3 @@ ]
     "version": "0.1.0",
-    "description": "Use of multiple SuccessStructures.",
+    "description": "<p>Use of multiple SuccessStructures.</p>",
     "success": {
@@ -975,3 +1038,3 @@ "fields": {
             "optional": false,
-            "description": "This is Success 3 (local)."
+            "description": "<p>This is Success 3 (local).</p>"
           },
@@ -982,3 +1045,3 @@ {
             "optional": false,
-            "description": "This is Success 1."
+            "description": "<p>This is Success 1.</p>"
           },
@@ -989,3 +1052,3 @@ {
             "optional": false,
-            "description": "This is Success 2."
+            "description": "<p>This is Success 2.</p>"
           }
@@ -1005,3 +1068,3 @@ ]
             "optional": false,
-            "description": "This is Error 1."
+            "description": "<p>This is Error 1.</p>"
           }
@@ -1025,3 +1088,3 @@ ]
             "optional": false,
-            "description": "This is Error 2."
+            "description": "<p>This is Error 2.</p>"
           }
@@ -1045,3 +1108,3 @@ ]
             "optional": false,
-            "description": "This is Header 2."
+            "description": "<p>This is Header 2.</p>"
           }
@@ -1065,3 +1128,3 @@ ]
             "optional": false,
-            "description": "This is Header 1."
+            "description": "<p>This is Header 1.</p>"
           }
@@ -1085,3 +1148,3 @@ ]
             "optional": false,
-            "description": "This is Field 1."
+            "description": "<p>This is Field 1.</p>"
           }
@@ -1105,3 +1168,3 @@ ]
             "optional": false,
-            "description": "This is Field 2."
+            "description": "<p>This is Field 2.</p>"
           }
@@ -1125,3 +1188,3 @@ ]
             "optional": false,
-            "description": "This is Success 1."
+            "description": "<p>This is Success 1.</p>"
           }
@@ -1145,3 +1208,3 @@ ]
             "optional": false,
-            "description": "This is Success 2."
+            "description": "<p>This is Success 2.</p>"
           }
@@ -1165,3 +1228,3 @@ ]
             "optional": false,
-            "description": "This is Error 1."
+            "description": "<p>This is Error 1.</p>"
           }
@@ -1168,0 +1231,0 @@ ]

test/fixtures/api_project.js

 define({
   "name": "test",
-  "version": "1.2.3",
+  "version": "0.5.0",
   "description": "RESTful web API Documentation Generator",
@@ -14,5 +14,5 @@ "header": {
   "generator": {
-    "version": "0.5.0",
-    "time": "2014-06-27T13:09:11.199Z"
+    "version": "0.6.0",
+    "time": "2014-07-10T14:42:38.537Z"
   }
 });

test/fixtures/api_project.json

 {
   "name": "test",
-  "version": "1.2.3",
+  "version": "0.5.0",
   "description": "RESTful web API Documentation Generator",
@@ -14,5 +14,5 @@ "header": {
   "generator": {
-    "version": "0.5.0",
-    "time": "2014-06-27T13:09:11.199Z"
+    "version": "0.6.0",
+    "time": "2014-07-10T14:42:38.537Z"
   }
 }

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

712413

increased by2.02%

Number of package files

147

increased by2.08%

Lines of code

8714

increased by5%

Number of lines in readme file

103

increased by10.75%

Worsened metrics

Number of low supply chain risk alerts

13

increased by8.33%

No dependency changes