zhdev/oblak
1
0
Fork 0
Code Issues Pull requests Activity

docs: add annotation processing instructions

Browse source
This commit is contained in:
Citymonstret 2022-06-06 21:32:14 +02:00 • committed by Jason
parent 4360847852
commit 16ea203a79
1 changed files with 68 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

68
docs/README.adoc
View file

@ -37,6 +37,7 @@ https://javadoc.io/doc/cloud.commandframework[JavaDocs] and use them as the prim
Cloud is available through https://search.maven.org/search?q=cloud.commandframework[Maven Central]. Cloud is available through https://search.maven.org/search?q=cloud.commandframework[Maven Central].
*Maven*
[source,xml,subs="attributes,verbatim"] [source,xml,subs="attributes,verbatim"]
---- ----
<dependency> <dependency>
@ -46,6 +47,18 @@ Cloud is available through https://search.maven.org/search?q=cloud.commandframew
</dependency> </dependency>
---- ----
*Gradle (Groovy)*
[source,groovy,subs="attributes,verbatim"]
----
implementation 'cloud.commandframework:cloud-core:{cloud-version}'
----
*Gradle (Kotlin)*
[source,kotlin,subs="attributes,verbatim"]
----
implementation("cloud.commandframework:cloud-core:{cloud-version}")
----
If you want to use snapshot builds, then they are available the Sonatype snapshots repository: If you want to use snapshot builds, then they are available the Sonatype snapshots repository:
[source,xml] [source,xml]
@ -699,6 +712,58 @@ Annotations allow for an alternative way of declaring commands in cloud. Instead
using builders, commands consist of annotated instance methods. Command arguments will be bound to the using builders, commands consist of annotated instance methods. Command arguments will be bound to the
method parameters, instead of being retrieved through the command context. method parameters, instead of being retrieved through the command context.
NOTE: Since version 1.7.0, `cloud-annotations` will now also perform
annotation processing, verifying that `@CommandMethod` annotated methods
have valid signatures, etc.
=== Install
In order to use the annotation parser & annotation processor, you need to
add `cloud-annotations` as a dependency:
*Maven*
[source,xml,subs="attributes,verbatim"]
----
<dependency>
<groupId>cloud.commandframework</groupId>
<artifactId>cloud-annotations</artifactId>
<version>{cloud-version}</version>
</dependency>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>cloud.commandframework</groupId>
<artifactId>cloud-annotations</artifactId>
<version>{cloud-version}</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</build>
----
*Gradle (Groovy)*
[source,groovy,subs="attributes,verbatim"]
----
implementation 'cloud.commandframework:cloud-annotations:{cloud-version}'
annotationProcessor 'cloud.commandframework:cloud-annotations:{cloud-version}'
----
*Gradle (Kotlin)*
[source,kotlin,subs="attributes,verbatim"]
----
implementation("cloud.commandframework:cloud-annotations:{cloud-version}")
annotationProcessor("cloud.commandframework:cloud-annotations:{cloud-version}")
----
=== Annotation Parser === Annotation Parser
In order to work with annotated command methods you need to construct an annotation parser. In order to work with annotated command methods you need to construct an annotation parser.
@ -953,6 +1018,9 @@ annotationParser.registerPreprocessorMapper(
); );
---- ----
=== @CommandContainer
TODO
== Kotlin DSL == Kotlin DSL
TODO TODO