antlr / antlr/antlr4

provide examples for maven plugin parameters

Open
#598 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
Java
Stars
19k
Forks
3.5k
PR merge metrics
No merged PRs in 30d

Description

The maven plugin has a help goal (antlr4:help -Ddetail=true), but the resulting list should give the syntax for the parameters when used in a pom.xml file. For example, the antlr4:antlr4 goal describes "arguments" as "A list of additional command line arguments to pass to the ANTLR tool." Would be handy if this description showed the syntax to use for the "list".

This would not necessarily have to be in the maven goal's output (though that would be nice), but at least the website could give details.

Information needed:
- XML hierarchy for the parameters.
- Syntax for the parameters: tag names, tag values, etc.
- Some parameters are on/off, others have values. Need details for both.
- Some parameters are default on, others default off. Details on how to reverse a value.

I have looked through the maven documentation, but nothing I have tried yet works.
I have turned on maven debugging, but that has not yet shown enough to help.

Contributor guide

Open the contributing guide

Research direction

Start by running the documented antlr4:help -Ddetail=true goal and inspecting the antlr4:antlr4 goal's parameter descriptions, especially arguments. Compare the output with the Maven plugin documentation on the website; done means documenting each parameter's XML hierarchy, tag syntax, values, defaults, and how to reverse boolean settings.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Documentation
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.