From 5f43fc4fb3de1d08a718f820cbac78f921be5cf1 Mon Sep 17 00:00:00 2001
From: Johannes Hoermann <j.hoermann@adito.de>
Date: Fri, 30 Nov 2018 14:57:04 +0100
Subject: [PATCH] update lib documentation
---
others/guide/how to write JDito code.adoc | 1 +
others/guide/instanceableLibExample.adoc | 1 +
others/guide/staticLibExample.adoc | 1 +
3 files changed, 3 insertions(+)
diff --git a/others/guide/how to write JDito code.adoc b/others/guide/how to write JDito code.adoc
index cd9eef70656..246924f1911 100644
--- a/others/guide/how to write JDito code.adoc
+++ b/others/guide/how to write JDito code.adoc
@@ -143,6 +143,7 @@ So just start your functions / methods name with a _ if you need private methods
--> do not use functions which start with a _ outside of the class!
+Add @ignore to the Comment of the function.
== JS-Doc ==
diff --git a/others/guide/instanceableLibExample.adoc b/others/guide/instanceableLibExample.adoc
index bbc7a88b001..56e7760a794 100644
--- a/others/guide/instanceableLibExample.adoc
+++ b/others/guide/instanceableLibExample.adoc
@@ -43,6 +43,7 @@ UtilClass.prototype.myFunction = function(param1, param2) {
* @param {String} param3 is for ...
*
* @return {String} a result
+ * @ignore
*/
UtilClass.prototype._myPrivateFunction = function(param1, param2, param3) {
if(param1 && param2 && param3) {
diff --git a/others/guide/staticLibExample.adoc b/others/guide/staticLibExample.adoc
index e98a7822630..90003eb7f69 100644
--- a/others/guide/staticLibExample.adoc
+++ b/others/guide/staticLibExample.adoc
@@ -39,6 +39,7 @@ ExampleUtils.staticFunction1 = function(param1, param2) {
* @param {String} param3 is for ...
*
* @return {String} a result
+ * @ignore
*/
ExampleUtils._privateStaticFunction1 = function(param1, param2, param3) {
if(param1 && param2) {
--
GitLab