Skip to content

(doc) Simplify documentation #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slawekjaranowski merged 1 commit into from
Jan 4, 2022
Merged

(doc) Simplify documentation #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 3 additions & 12 deletions maven-plugin-plugin/src/site/apt/examples/using-annotations.apt.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,8 @@ Using Plugin Tools Java Annotations

* POM configuration

To be able to use these Java annotations, you need to add some configuration to your plugin POM:

* add <<<maven-plugin-annotations>>> dependency, preferably with <<<provided>>> scope,

* override Maven core's <<<default-descriptor>>> execution phase to <<<process-classes>>>,

[]
To be able to use these Java annotations, you need to add to your plugin POM
<<<maven-plugin-annotations>>> dependency, preferably with <<<provided>>> scope.

+-----+
<project>
Expand All @@ -94,7 +89,7 @@ Using Plugin Tools Java Annotations
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>${project.version}</version>
<optional>true</optional> <!-- annotations are not used at runtime because @Retention(value=CLASS), they are needed only to build the plugin -->
<scope>provided</scope> <!-- annotations are not used at runtime because @Retention(value=CLASS), they are needed only to build the plugin -->
</dependency>
</dependencies>
...
Expand All @@ -105,10 +100,6 @@ Using Plugin Tools Java Annotations
<artifactId>maven-plugin-plugin</artifactId>
<version>${project.version}</version>
<executions>
<execution>
<id>default-descriptor</id>
<phase>process-classes</phase>
</execution>
<!-- if you want to generate help goal -->
<execution>
<id>help-goal</id>
Expand Down