Generierung von javadoc als word-Dokument

Wie können wir das generieren der javadoc als word-Dokument anstelle der traditionellen html-Seiten?

InformationsquelleAutor ria | 2009-10-22
  1. 7

    Blick in doclets, http://doclet.com, die eine Menge von Beispielen für benutzerdefinierte javadoc-rendering (ich.e in PDF ' s etc...) und auch einen Blick in Apache POI (http://poi.apache.org/) für die Generierung von MS Office-Dateien

    InformationsquelleAutor Mark
  2. 4

    Wenn könnten Sie live mit pdf statt word, sollten Sie PDFDoclet eine chance. Ich entdeckte es auf doclet.com (vielen Dank an Mark für den link). Es funktioniert ganz gut, ist einfach zu verwenden und erlaubt einige Konfiguration. Für meine Zwecke, pdf ist besser geeignet als word, weil ein pdf-Dokument eignet sich besser zum Lesen als ein Wort in Bezug auf die benötigten viewer-Anwendung.

    Hier ist mein kleiner windows-batch-Datei:

    echo OFF

set JAVA_HOME=C:/program files/Java/jdk1.6.0_23
set PATH=%JAVA_HOME%/bin;%PATH%
set VERSION=1.0.2
set DOCLET=com.tarsec.javadoc.pdfdoclet.PDFDoclet
set JARS=jar/pdfdoclet-%VERSION%-all.jar
set PACKAGE="cvu.html"

javadoc -doclet %DOCLET% -docletpath %JARS% -pdf html.pdf -config example/html/config_html.properties -private -sourcepath example/html -subpackges %PACKAGE%
    • gut, ja, sicherlich. Mein Punkt ist: wählen Sie das richtige Werkzeug für den job. für pdf vorhanden ist, mehrere relativ kleine Leser beim Wort verlangt einen ziemlich aufgeblähten editor nur für das Lesen eines javadoc-Dokument. Ich update meine Antwort auf clearify meine Gedanken.
    • Sie sind batch-Datei einen Tippfehler auf die Unterpakete parameter
    • danke, PDFDoclet macht den job sehr gut, und einfach zu lauch im Eclipse-Projekt > Generate javadoc. Wenn nötig, die PDF-Ausgabe kann immer umgewandelt werden in word, ich personnaly verwenden Alle PDF Converter Pro, es funktioniert wie ein Charme.
    InformationsquelleAutor remipod
  3. 1

    http://doclet.com/ links eine RTF-Doclet ("RTF-Doclet erzeugt RTF-format-Dokumentation.")
    Die resultierende RTF-öffnet sich in Word und Open Office Writer.

    InformationsquelleAutor weberjn
  4. 1

    Können Sie maven ausführen pdfdoclet. Obwohl ich keine "offizielle" maven-repository die folgenden scheint mir klar, im Gegensatz zum hantieren mit shell-Skripten oder mit Hilfe von ant-Befehle in maven, wie vorgeschlagen, auf Ihre website:

            <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.9.1</version>

            <configuration>
                <doclet>com.tarsec.javadoc.pdfdoclet.PDFDoclet</doclet>
                <docletPath>path/to/pdfdoclet-1.0.2-all.jar</docletPath>
                <useStandardDocletOptions>false</useStandardDocletOptions>
            </configuration>
        </plugin>

    Hinweis: die Deaktivierung der standard-Optionen, ansonsten javadoc beschwert sich der unbekannte Optionen (anscheinend nicht unterstützt von der pdfdoclet)

    Von dort aus können Sie beginnen, customizing, mit dem stets prägnant maven Dokumentation

    InformationsquelleAutor Tommy
  5. -1

    Können Sie nicht generieren ein Word-Dokument direkt. Allerdings könnten Sie versuchen, zu generieren Word-Dokument(en) aus den generierten html-Dateien: Google-Suche

    InformationsquelleAutor sfussenegger
Schreibe einen Kommentar