apidoc - npm Package Compare versions

Comparing version 0.2.2 to 0.2.3

CHANGELOG.md

 # apiDoc Changelog
 
+#### 0.2.3
+Extend Template with url-param "compare=1" to show the compare version on page view.
+Bugfix: Minor fix with double structure examples.
+
 #### 0.2.2
@@ -4,0 +8,0 @@ Bugfix: Template not show @apiSuccessExample @apiErrorExample.

lib/parser.js

@@ -160,3 +160,3 @@ var fs = require("fs");
 							}
-	
+
 							if(preventGlobal === true)
@@ -163,0 +163,0 @@ {

lib/plugins/worker_error_title.js

@@ -32,3 +32,3 @@ var apiWorker = require("./worker_param_title.js");
 	preProcess: preProcess,
-	postProcess: postProcess,
+	postProcess: postProcess
 };

lib/plugins/worker_info_title.js

@@ -32,3 +32,3 @@ var apiWorker = require("./worker_param_title.js");
 	preProcess: preProcess,
-	postProcess: postProcess,
+	postProcess: postProcess
 };

lib/plugins/worker_param_title.js

@@ -88,3 +88,3 @@ /**
 	preProcess: preProcess,
-	postProcess: postProcess,
+	postProcess: postProcess
 };

lib/plugins/worker_success_title.js

@@ -32,3 +32,3 @@ var apiWorker = require("./worker_param_title.js");
 	preProcess: preProcess,
-	postProcess: postProcess,
+	postProcess: postProcess
 };

package.json

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

template/main.js

@@ -381,3 +381,20 @@ require.config({
 	$("article .versions li.version a").on("click", changeVersionCompareTo);
-	
+
+	$.urlParam = function(name) {
+		var results = new RegExp('[\\?&]' + name + '=([^&#]*)').exec(window.location.href);
+		return (results && results[1]) ? results[1] : null;
+	};
+
+	if($.urlParam("compare"))
+	{
+		// URL Paramter ?compare=1 is set.
+		$("#compareAllWithPredecessor").trigger("click");
+
+		if(window.location.hash)
+		{
+			var id = window.location.hash;
+			$('html,body').animate({ scrollTop: parseInt($(id).offset().top) - 18 }, 0);
+		}
+	}
+
 	/**
@@ -384,0 +401,0 @@ *

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

1094831

increased by0.05%

Lines of code

8219

increased by0.17%

No dependency changes