Gerando Javadoc como um documento do Word

StackOverflow https://stackoverflow.com/questions/1606255

  •  05-07-2019
  •  | 
  •  

Pergunta

Como podemos gerar Javadoc como um documento do Word em vez das páginas HTML tradicionais?

Foi útil?

Solução

Olhe para doclets, http://doclet.com que têm muitos exemplos de renderização Javadoc personalizada (ou seja, nos PDFs etc ...) e também procuram Apache Poi (http://poi.apache.org/) para a geração de arquivos do MS Office

Outras dicas

Se você pudesse viver com pdf em vez de palavras, você deve dar Pdfdoclet uma chance. Eu o descobri no doclet.com (graças a Mark pelo link). Funciona muito bem, é fácil de usar e permite alguma configuração. Para minha finalidade, o PDF é mais adequado que o Word, porque um documento PDF é mais adequado para leitura do que uma palavra em relação ao aplicativo do visualizador necessário.

Aqui está o meu pequeno arquivo em lote do Windows:

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%

http://doclet.com/ Links Um doclet RTF ("O Doclet RTF gera documentação do formato RTF.") O RTF resultante é aberto no Word e Open Office Writer.

Você pode usar o maven para executar o pdfdoclet. Embora eu não tenha encontrado nenhum repositório "oficial" do Maven, o seguinte me parece mais claro, oposto a brincar com scripts de concha ou usar commandos de formigas no Maven, como proposto em seus local na rede Internet:

        <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>

Observe a desativação das opções padrão, caso contrário, Javadoc reclama de opções desconhecidas (aparentemente não suportadas pelo PDFDoclet)

A partir daí, você pode começar a personalizar, usando o sempre consultivo Documentação do MAVEN

Você não pode gerar um documento do Word diretamente. No entanto, você pode tentar gerar documentos do Word (s) a partir de arquivos HTML gerados: Pesquisar no Google

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top