From e1a4e278abb1c9eecf31a53e9447eb4f716aeb91 Mon Sep 17 00:00:00 2001
From: Johannes Hoermann <j.hoermann@adito.de>
Date: Fri, 30 Nov 2018 08:35:21 +0100
Subject: [PATCH] staticLibExample
---
others/guide/staticLibExample.adoc | 52 ++++++++++++++++++++++++++++++
1 file changed, 52 insertions(+)
create mode 100644 others/guide/staticLibExample.adoc
diff --git a/others/guide/staticLibExample.adoc b/others/guide/staticLibExample.adoc
new file mode 100644
index 00000000000..2b668afeb18
--- /dev/null
+++ b/others/guide/staticLibExample.adoc
@@ -0,0 +1,52 @@
+= 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
--
GitLab