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

refactor documentation, genJsdoc.bat überarbeitet. Kann aus dem Designer nun aufgerufen werden.

Speicherort für jsDocs in others verlegt, damit es im Designer sichtbar ist
parent b92fe364
No related branches found
No related tags found
No related merge requests found
......@@ -2,4 +2,4 @@
/data
/others/db_changes/liqui_update.bat
/others/db_changes/liqui_reset.ps1
/jsdocOut
\ No newline at end of file
/others/jsdocOut
\ No newline at end of file
jsdoc -r ..\process -d ..\jsdocOut
\ No newline at end of file
SET mypath=%~dp0
jsdoc -r %mypath:~0,-1%\..\process -d %mypath:~0,-1%\jsdocOut
\ No newline at end of file
How to build js-doc out of the lib-comments
===========================================
:toc2: left
:numbered:
== installation ==
1. Nodejs:
https://nodejs.org/en/
LTS-version (aktuell 10.15.0)
download and install
https://nodejs.org/en/
LTS-version (aktuell 10.15.0)
download and install
2. install jsdoc
open CMD
[source]
----
npm install -g jsdoc
----
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
1. open CMD
2. navigate into the project-folder. e.g.
[source]
----
C:
cd C:\Users\M.Mustermann\Documents\AditoProjects\xRM-Basic5.1
----
3. run command
[source]
----
jsdoc -r process -d others\jsdocOut
----
4. Open others\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
=== with script in designer (Windows) ===
1. In the Designer right click on others\genJsdoc.bat -> "Open in System"
2. Right click on others\jsdocOut\index.html -> "View"
\ No newline at end of file
= Example for a instanceable Lib =
:toc2: left
:numbered:
Remember to always change the comments to fit your class! +
Use speaking names for ALL variables, classes and functions!
......
= Example for a static Lib =
:toc2: left
:numbered:
Remember to always change the comments to fit your class! +
Use speaking names for ALL variables, classes and functions!
......
Overview over datatypes
=======================
:toc2: left
:numbered:
This is a simple overview about when to to use which datatype.
......
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