staticLibExample

others/guide/staticLibExample.adoc

+= Example for a static Lib =
+
+Remember to always change the comments to fit your class!
+
+[source,javascript]
+----
+import("...");
+
+/**
+ * a static Example Utility class
+ * 
+ * Do not create an instance of this!
+ * @class
+ */
+function ExampleUtils() {}
+
+/**
+ * a public static function
+ * 
+ * @param {String} param1 is for ...
+ * @param {String} param2 is for ...
+ * 
+ * @example var myResult = ExampleUtils.staticFunction1("p1", "p2");
+ * 
+ * @return {String} a result
+ */
+ExampleUtils.staticFunction1 = function(param1, param2)
+{
+    return this._privateStaticFunction1(param1, param2, "-")
+}
+
+/**
+ * a private static function
+ * 
+ * Do not use outside of ExampleUtils!
+ * 
+ * @param {String} param1 is for ...
+ * @param {String} param2 is for ...
+ * @param {String} param3 is for ...
+ * 
+ * @return {String} a result
+ */
+ExampleUtils._privateStaticFunction1 = function(param1, param2, param3)
+{
+    if(param1 && param2) {
+        ...
+        return param1 + param3 + param2;
+    }
+
+    return "";
+}
+----
\ No newline at end of file