diff --git a/others/guide/how to write JDito code.adoc b/others/guide/how to write JDito code.adoc index cf528af02c2b45a29292ee444f76610101228589..cd6e8b4d635476ced35c0911c5ce7dff43b6e02e 100644 --- a/others/guide/how to write JDito code.adoc +++ b/others/guide/how to write JDito code.adoc @@ -147,7 +147,7 @@ Add @ignore to the comment of the private functions. == JS-Doc == <1> JS-Doc comment: http://usejsdoc.org/ -<2> jsdoc-blocks have to start with /** because the tool to generate docs out of jsdoc only works with /** +<2> jsdoc-blocks have to start with /** because the tool to generate docs out of jsdoc only works with /** <3> use the correct form for optional/required parameters: http://usejsdoc.org/tags-param.html Optional parameter: [alias=the current alias] Required parameter: alias @@ -170,7 +170,7 @@ function SqlCondition(pAlias) <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 +<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) See also HowToSqlConditionLib.adoc for a full documentation.