Maven - Documentos do Projeto

Este tutorial irá ensiná-lo a criar a documentação do aplicativo de uma vez. Então, vamos começar, vá para o diretório C: / MVN onde você criou seu javaconsumerBankingaplicação usando os exemplos dados nos capítulos anteriores. AbrirconsumerBanking pasta e execute o seguinte mvn comando.

C:\MVN>mvn site

Maven começará a construir o projeto.

[INFO] Scanning for projects...
[INFO]-----------------------------------------------
[INFO] Building consumerBanking
[INFO] task-segment: [site]
[INFO]-----------------------------------------------
[INFO] [site:site {execution: default-site}]
[INFO] artifact org.apache.maven.skins:maven-default-skin:
checking for updates from central

[INFO] Generating "About" report.
[INFO] Generating "Issue Tracking" report.
[INFO] Generating "Project Team" report.
[INFO] Generating "Dependencies" report.
[INFO] Generating "Continuous Integration" report.
[INFO] Generating "Source Repository" report.
[INFO] Generating "Project License" report.
[INFO] Generating "Mailing Lists" report.
[INFO] Generating "Plugin Management" report.
[INFO] Generating "Project Summary" report.

[INFO]-----------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO]-----------------------------------------------

[INFO] Total time: 16 seconds
[INFO] Finished at: Wed Jul 11 18:11:18 IST 2012
[INFO] Final Memory: 23M/148M
[INFO]-----------------------------------------------

A documentação do seu projeto agora está pronta. O Maven criou um site dentro do diretório de destino.

Abra a pasta C: \ MVN \ consumerBanking \ target \ site. Clique em index.html para ver a documentação.

O Maven cria a documentação usando um mecanismo de processamento de documentação chamado Doxia, que lê vários formatos de origem em um modelo de documento comum. Para escrever a documentação do seu projeto, você pode escrever o seu conteúdo nos seguintes formatos comumente usados que são analisados pelo Doxia.

Nome do formato	Descrição	Referência
XDoc	Um formato de documentação Maven 1.x	https://jakarta.apache.org/site
FML	Usado para documentos de FAQ	https://maven.apache.org