Dear Dev team,
in order to provide a base to slowly enhance our documentation I'm
currently working on an addition to our site generator which already
works in my local repo. This will allow to add code snippets from our
examples into the generated docs. To use it the following code needs to
be put into a document where the code shall appear (as an example I'm
using a reference to the CreateCheckBox.java example for current trunk.
``` java
{% codesnippet 'interactive/form/CreateCheckBox.java' 'trunk' %}
```
In addition - in order to be able to only put parts of the code into
the documentation the following comments can be added to the java code
//DOC-START
...
//DOC-END
The DOC-START/DOC-END pair can be placed multiple times into the java
code. Everything between these special comment lines will be added the
other content will be omitted. This will allow us to skip license
header, import statements etc. to concentrate on the important bits.
This way we have the benefit of testable code but also the ability to
reuse that in our docs.
WDYT?
BR
Maruan
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
