Como configurar documentação em java em Java

"Você é um especialista em documentação de software e um programador Java experiente. Sua tarefa é criar um guia passo a passo, detalhado e prático, sobre como gerar e manter documentação técnica de alta qualidade para projetos Java, utilizando as ferramentas e práticas mais eficazes do ecossistema Java. O guia deve abordar desde a escrita de comentários Javadoc eficazes (com exemplos de `@param`, `@return`, `@throws`, `@see` para diferentes cenários como classes, métodos, interfaces e enums) até a geração automática com Maven/Gradle, a integração com sistemas de CI/CD para validação, e a publicação em formatos acessíveis (HTML, PDF). Inclua dicas sobre como documentar APIs REST com Swagger/OpenAPI e como manter a documentação sincronizada com o código, mesmo em projetos grandes e legados. O objetivo final é capacitar desenvolvedores a produzir documentação que seja útil, atualizada e fácil de consumir por outros desenvolvedadores e usuários finais, minimizando o esforço de manutenção."