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

js-doc tutorial und script

parent 22f18d3a
No related branches found
No related tags found
No related merge requests found
/.aditoprj/cache
/data
/others/db_changes/liqui_update.bat
/others/db_changes/liqui_reset.ps1
\ No newline at end of file
/others/db_changes/liqui_reset.ps1
/jsdocOut
\ No newline at end of file
jsdoc -r ..\process -d ..\jsdocOut
\ No newline at end of file
How to build js-doc out of the lib-comments
===========================================
== installation ==
1. Nodejs:
https://nodejs.org/en/
LTS-version (aktuell 10.15.0)
download and install
2. install jsdoc
CMD öffnen
[source,javascript]
----
npm install -g jsdoc
----
== generate jsdoc ==
=== manually ===
1. In das Projektverzeichnis navigieren. z.B.
[source,javascript]
----
C:
cd C:\Users\M.Mustermann\Documents\AditoProjects\xRM-Basic5.1
----
2. jsdoc -r process -d jsdocOut
3. Open jsdocOut\index.html with a webbrowser
=== with script (Windows) ===
1. Double click on others/genJsdoc.bat
2. Open jsdocOut\index.html with a webbrowser
\ No newline at end of file
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