Skip to content
Snippets Groups Projects
Commit aeae7fcf authored by Johannes Goderbauer's avatar Johannes Goderbauer
Browse files

fix of wrong asciidoc for comment symbols: /**

parent ba3a15e8
No related branches found
No related tags found
No related merge requests found
......@@ -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 /&#x002A;&#x002A; because the tool to generate docs out of jsdoc only works with /&#x002A;&#x002A;
<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 /&#x002A;&#x002A; not /&#x002A; 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.
......
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