apache / apache/maven-javadoc-plugin

[MJAVADOC-759] protected static --> static in JavadocUtil

Open
#1,115 0 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

**[Elliotte Rusty Harold](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=elharo)** opened **[MJAVADOC-759](https://issues.apache.org/jira/browse/MJAVADOC-759?redirect=false)** and commented

JavadocUtil is essentially a static utility class that should not be instantiated or subclassed. However it has many protected static methods that likely should have been package protected (default access) instead.

If we can stomach the minor API breakage of hiding these methods, that makes some other changes like moving to the Tool Provider API simpler.

---
No further details from [MJAVADOC-759](https://issues.apache.org/jira/browse/MJAVADOC-759?redirect=false)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating JavadocUtil and reviewing its protected static methods and their callers. Check the plugin's existing tests before changing access, and consider the API-breakage concern described in the issue. Done means the intended methods are package-protected and the existing test suite still passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.