Latex Javadoc-generation

Gibt es einen Weg zur Erzeugung eines latex-Dokuments von meinem java-Quellcode-Dateien Dokumentation?
Ich will nicht zu zählen LaTeX-Elemente in meiner Dokumentation Kommentare, ich möchte einfach zum erstellen von LaTeX-Dateien anstelle von HTML.

Dank

  • Möchten Sie zu schreiben LaTeX in deiner Javadoc, oder zur Erstellung eines LaTeX-Dokuments von Ihrem javadoc-html-website ? Zum ersten, ich denke, Harry-Lösung passend zu Ihrem Bedarf. Für die zweite ...
  • Sie erwähnen, java.net/projects/texdoclet, aber wie kann ich die benutzen/installieren?
InformationsquelleAutor Konstantin Weitz | 2011-05-03
  1. 4

    Texdoclet scheint zu sein, was Sie brauchen. Wie zu verwenden: genauso wie alle anderen doclet.

    • Wissen Sie, die Klasse-I angeben, für den die option?
    • Nein, aber es sollte leicht zu finden sein wenn man sich innerhalb der JAR-Datei.
    • Es tut nicht brechen, aber alle die ich bekomme sind html-Dateien. javadoc -d out -docletpath /home/konne/Downloads/texdoclet.jar *
    • Sie haben beide die -doclet und das -docletpath Optionen. Die erste ist, zu sagen, die javadoc-doclet-Klasse zu verwenden, die zweite sagt, wo es zu finden das Klasse.
    • Danke es ist eine Art von arbeiten. Es sagt mir ! LaTeX Error: Environment texdocclass undefined.. Aber ich denke, Sie weiß nicht, wie man dieses Problem lösen.
    • Nein, tut mir Leid. Es scheint eine sehr schlecht dokumentiert-Projekt.

    InformationsquelleAutor Michael Borgwardt
  2. 6

    Alternative zu Texdoclet ist die ltxdoclet ich erstellt.

    Ich denke, der wesentliche Unterschied ist, dass es enthält auch den source code, nicht nur den Javadoc-Kommentaren, wenn Sie können, schalten Sie diese aus.

    Es ist nicht sehr gut dokumentiert auf der github-Seite - laden Sie einfach den code und führen Sie ant pdfdoku ein Beispiel für die Ausgabe (ant latexdoku wenn Sie nur wollen, dass die LaTeX-Dateien). (Es wird dokumentiert, in Deutsch, obwohl.)

    Ich sollte wirklich fügen Sie eine readme-Datei gibt.

    Für jetzt, hier ist die jar-Datei - laden Sie es irgendwo, und verwenden Sie dann

     javadoc -docletpath ltxdoclet.jar -doclet de.dclj.paul.ltxdoclet.DocletStart -help

    sehen eine Liste von Optionen zur Verfügung. (Diese werden in Deutsch, wenn du kein Englisches Gebietsschema. Präfix mit "LC_ALL=de_de" oder ähnliches bash für die englische version, oder haben Sie einen Blick auf help_en.txt statt, wenn Sie nicht wissen, Deutsch.)

    Ich arbeite an einer Webseite mit einigen Dokumentation, aber ich bin mir nicht sicher Wann es fertig sein wird.

    Nun haben wir eine Webseite, zu. Es verbindet die jar-Datei und auch als ein Beispiel der javadocs, wenn angewandt, auf sich selbst.

    • Möchte es nutzen, aber nicht über die Ameise um jetzt
    • Ich habe eine jar-Datei für Sie.
    • Ich kann nicht scheinen, um die Erstellung meiner Dokumentation in Englisch, ich habe versucht LC_ALL=en_US javadoc... war das nicht das, was du meintest?
    InformationsquelleAutor Paŭlo Ebermann
  3. 0

    Wenn Sie nicht wollen, setzen auf doclet Abhängigkeit, sondern auf einem javascript, können Sie fügen Sie einfach die folgende javadoc-param:

    -header "<script type='text/javascript' src='http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>"

    und dann einfach mit sauberer latex-innen Ihre Kommentare, wie \(\sum_i a_i\) oder \[\sum_i a_i\]

    InformationsquelleAutor Arie
Schreibe einen Kommentar