diff --git a/others/guide/how to write JDito code.adoc b/others/guide/how to write JDito code.adoc index 246924f19110216471e418f6ae26785f5b366f4e..7f4e9bdabf3b0c2e868ce07aa6133c7ef8360bf8 100644 --- a/others/guide/how to write JDito code.adoc +++ b/others/guide/how to write JDito code.adoc @@ -143,7 +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. +Add @ignore to the comment of the private functions. == JS-Doc == @@ -168,6 +168,7 @@ function SqlCondition(alias) { <3> examples are useful on more complex functions <4> constructor function; init properties (do not set functions ("methods") here!) <5> add functions ("methods") to the prototype, they are available through the prototype chain +<6> the comments have to start with /** not /* otherwise JSDoc cannot generate a documentation And how to use it (normally you'd want to use preparedStatements but for the sake of an easy example it's a bit shorter here) [source,javascript]