summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/javadoc/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/javadoc/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/javadoc/README')
-rw-r--r--macros/latex/contrib/javadoc/README7
1 files changed, 7 insertions, 0 deletions
diff --git a/macros/latex/contrib/javadoc/README b/macros/latex/contrib/javadoc/README
new file mode 100644
index 0000000000..a98aae44cd
--- /dev/null
+++ b/macros/latex/contrib/javadoc/README
@@ -0,0 +1,7 @@
+The javadoc package provides an easy way to document source code. It is related to the javadoc system for java source code and tries to provide the same descriptions. But, of course, source code of other languages can be documented using this package. The package is under GNU GENERAL PUBLIC LICENSE\footnote (see www.gnu.org).
+
+A doclet is a class derived from com.sun.javadoc.Doclet that can be used to generate a documentation with the javadoc-tool out of commented java-source-code. By default javadoc generates a HTML documentation, TexGen generates TeX-files according to the javadoc-package. The doclet is under GNU GENERAL PUBLIC LICENSE\footnote (see www.gnu.org).
+
+Das javadoc Package bietet eine einfache Möglichkeit, Dokumentationen von Quellcode zu erstellen. Es leitet sich vom Dokumentationssystem javadoc für Java ab und bietet dieselben Attribute an. Aber natürlich kann auch Quellcode anderer Sprachen damit dokumentiert werden. Das Paket steht unter GNU GENERAL PUBLIC LICENSE\footnote (see www.gnu.org).
+
+Ein Doclet ist eine von com.sun.javadoc.Doclet abgeleitete Klasse, die verwendet werden kann, um mit dem Javadoc-Tool aus kommentierten Java-Quellcode-Dateien eine Dokumentation zu generieren. Standardmäßig werden HTML Dateien generiert, TexGen generiert TeX-Dateien gemäß dem javadoc-Package. Das Doclet steht unter GNU GENERAL PUBLIC LICENSE\footnote (see www.gnu.org).