apache / apache/maven-javadoc-plugin

[MJAVADOC-722] Allow Logging Javadoc Warnings and Errors to File

Open
#1,092 2 comments 0 reactions 0 assignees View on GitHub
enhancement priority:minor
Dominant language
Java
Stars
107
Forks
116
Avg merge
1d 10h
Merged PRs (30d)
16

Description

**[Alan Zimmer](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=alzimmer)** opened **[MJAVADOC-722](https://issues.apache.org/jira/browse/MJAVADOC-722?redirect=false)** and commented

Allow for Javadoc generation, either implicitly or through a new configuration, to generate a file containing the warnings and errors that were found during Javadoc generation. Possibly following a similar pattern to the argfile  and options that are generated containing parameters passed to Javadoc create an errors files that will be placed in the Javadoc output folder that is ignored during Javadoc JAR creation.

 

This change would allow for CI systems to run Javadoc builds in parallel while still easily capturing any errors without the need for complex logging systems and would strongly ensure that there is a unique error report for each project.

---

**Remote Links:**
- [GitHub Pull Request #159
](https://github.com/apache/maven-javadoc-plugin/pull/159)

Contributor guide

No contributing guide indexed for this repository

Research direction

Review pull request #159 and the Maven Javadoc plugin's existing argfile and options-file generation described in the issue. Determine how Javadoc warnings and errors are captured and where generated files are placed, then verify that the resulting report is unique per project and excluded from Javadoc JAR creation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.