Skip to content
Snippets Groups Projects
Commit 5f43fc4f authored by Johannes Hörmann's avatar Johannes Hörmann
Browse files

update lib documentation

parent 70427784
No related branches found
No related tags found
No related merge requests found
......@@ -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 ==
......
......@@ -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) {
......
......@@ -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) {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment