Merge pull request #78 from holixon/feature/kdoc_improvements

[#18] Feature/kdoc improvements

Author: smcvb

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/AggregateLifecycleExtensions.kt

@@ -25,6 +25,7 @@ import org.axonframework.modelling.command.ApplyMore
  * Alias for [AggregateLifecycle.apply] method.
  * @param payload payload of the event message to be applied.
  * @return fluent instance to apply more.
+ * @since 0.2.0
  */
 fun applyEvent(payload: Any): ApplyMore = AggregateLifecycle.apply(payload)
 
@@ -33,12 +34,15 @@ fun applyEvent(payload: Any): ApplyMore = AggregateLifecycle.apply(payload)
  * @param payload payload of the event message to be applied.
  * @param metaData metadata to be included into the event message.
  * @return fluent instance to apply more.
+ * @since 0.2.0
  */
 fun applyEvent(payload: Any, metaData: MetaData): ApplyMore = AggregateLifecycle.apply(payload, metaData)
 
 /**
  * Create new aggregate instance.
- * @param [T] aggregate type.
+ * @param T aggregate type.
  * @param factoryMethod factory method.
+ * @return new instance of an aggregate.
+ * @since 0.2.0
  */
 inline fun <reified T : Any> createNew(noinline factoryMethod: () -> T): Aggregate<T> = AggregateLifecycle.createNew(T::class.java, factoryMethod)

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/BuilderExtensions.kt

@@ -20,15 +20,17 @@ import org.axonframework.modelling.command.GenericJpaRepository
 
 /**
  * Reified version of the static builder for event souring repository.
- * @param [T] aggregate type.
+ * @param T aggregate type.
  * @return event sourcing repository builder for aggregate [T]
+ * @since 0.2.0
  */
 inline fun <reified T : Any> eventSourcingRepositoryBuilder() = EventSourcingRepository.builder(T::class.java)
 
 
 /**
  * Reified version of the static builder for JPA repository.
- * @param [T] aggregate type.
+ * @param T aggregate type.
  * @return Generic JPA repository builder for aggregate [T]
+ * @since 0.2.0
  */
 inline fun <reified T : Any> genericJpaRepositoryBuilder() = GenericJpaRepository.builder(T::class.java)

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/CommandGatewayExtensions.kt

@@ -25,9 +25,10 @@ import org.axonframework.messaging.MetaData
  * @param command The command to send
  * @param onError Callback to handle failed execution
  * @param onSuccess Callback to handle successful execution
- * @param [R] the type of result of the command handling
- * @param [C] the type of payload of the command
+ * @param R the type of result of the command handling
+ * @param C the type of payload of the command
  * @see CommandGateway.send
+ * @since 0.1.0
  */
 inline fun <reified C : Any, reified R : Any?> CommandGateway.send(
     command: C,

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/EventUpcaster.kt

@@ -23,6 +23,7 @@ import kotlin.reflect.KClass
 
 /**
  * Helpers for event upcaster.
+ * @since 0.1.0
  */
 object EventUpcaster {
     /**

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/QueryGatewayExtensions.kt

@@ -25,11 +25,12 @@ import java.util.concurrent.CompletableFuture
  * Reified version of [QueryGateway.query]
  * which expects a collection as a response using [org.axonframework.messaging.responsetypes.MultipleInstancesResponseType]
  * @param query Query to send
- * @param [Q] the type of payload of the query
- * @param [R] the type of result of the query
+ * @param Q the type of payload of the query
+ * @param R the type of result of the query
  * @return [CompletableFuture] wrapping the result of the query
  * @see QueryGateway.query
  * @see ResponseTypes
+ * @since 0.1.0
  */
 inline fun <reified R, reified Q> QueryGateway.queryMany(query: Q): CompletableFuture<List<R>> {
     return this.query(query, ResponseTypes.multipleInstancesOf(R::class.java))
@@ -40,11 +41,12 @@ inline fun <reified R, reified Q> QueryGateway.queryMany(query: Q): CompletableF
  * which expects a collection as a response using [org.axonframework.messaging.responsetypes.MultipleInstancesResponseType]
  * @param queryName Name of the query
  * @param query Query to send
- * @param [Q] the type of payload of the query
- * @param [R] the type of result of the query
+ * @param Q the type of payload of the query
+ * @param R the type of result of the query
  * @return [CompletableFuture] wrapping the result of the query
  * @see QueryGateway.query
  * @see ResponseTypes
+ * @since 0.1.0
  */
 inline fun <reified R, reified Q> QueryGateway.queryMany(queryName: String, query: Q): CompletableFuture<List<R>> {
     return this.query(queryName, query, ResponseTypes.multipleInstancesOf(R::class.java))
@@ -54,11 +56,12 @@ inline fun <reified R, reified Q> QueryGateway.queryMany(queryName: String, quer
  * Reified version of [QueryGateway.query]
  * which expects a single object as a response using [org.axonframework.messaging.responsetypes.InstanceResponseType]
  * @param query Query to send
- * @param [Q] the type of payload of the query
- * @param [R] the type of result of the query
+ * @param Q the type of payload of the query
+ * @param R the type of result of the query
  * @return [CompletableFuture] wrapping the result of the query
  * @see QueryGateway.query
  * @see ResponseTypes
+ * @since 0.1.0
  */
 inline fun <reified R, reified Q> QueryGateway.query(query: Q): CompletableFuture<R> {
     return this.query(query, ResponseTypes.instanceOf(R::class.java))
@@ -69,11 +72,12 @@ inline fun <reified R, reified Q> QueryGateway.query(query: Q): CompletableFutur
  * which expects a single object as a response using [org.axonframework.messaging.responsetypes.InstanceResponseType]
  * @param queryName Name of the query
  * @param query Query to send
- * @param [Q] the type of payload of the query
- * @param [R] the type of result of the query
+ * @param Q the type of payload of the query
+ * @param R the type of result of the query
  * @return [CompletableFuture] wrapping the result of the query
  * @see QueryGateway.query
  * @see ResponseTypes
+ * @since 0.1.0
  */
 inline fun <reified R, reified Q> QueryGateway.query(queryName: String, query: Q): CompletableFuture<R> {
     return this.query(queryName, query, ResponseTypes.instanceOf(R::class.java))
@@ -83,11 +87,12 @@ inline fun <reified R, reified Q> QueryGateway.query(queryName: String, query: Q
  * Reified version of [QueryGateway.query]
  * which expects an Optional object as a response using [org.axonframework.messaging.responsetypes.OptionalResponseType]
  * @param query Query to send
- * @param [Q] the type of payload of the query
- * @param [R] the type of result of the query
+ * @param Q the type of payload of the query
+ * @param R the type of result of the query
  * @return [CompletableFuture] wrapping the result of the query
  * @see QueryGateway.query
  * @see ResponseTypes
+ * @since 0.1.0
  */
 inline fun <reified R, reified Q> QueryGateway.queryOptional(query: Q): CompletableFuture<Optional<R>> {
     return this.query(query, ResponseTypes.optionalInstanceOf(R::class.java))
@@ -98,11 +103,12 @@ inline fun <reified R, reified Q> QueryGateway.queryOptional(query: Q): Completa
  * which expects an Optional object as a response using [org.axonframework.messaging.responsetypes.OptionalResponseType]
  * @param queryName Name of the query
  * @param query Query to send
- * @param [Q] the type of payload of the query
- * @param [R] the type of result of the query
+ * @param Q the type of payload of the query
+ * @param R the type of result of the query
  * @return [CompletableFuture] wrapping the result of the query
  * @see QueryGateway.query
  * @see ResponseTypes
+ * @since 0.1.0
  */
 inline fun <reified R, reified Q> QueryGateway.queryOptional(queryName: String, query: Q): CompletableFuture<Optional<R>> {
     return this.query(queryName, query, ResponseTypes.optionalInstanceOf(R::class.java))

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/QueryUpdateEmitterExtensions.kt

@@ -12,10 +12,11 @@ import org.axonframework.queryhandling.QueryUpdateEmitter
  *
  * @param update    incremental update
  * @param filter    predicate on query payload used to filter subscription queries
- * @param [Q]       the type of the query
- * @param [U]       the type of the update
+ * @param Q         the type of the query
+ * @param U         the type of the update
  * @see org.axonframework.queryhandling.QueryUpdateEmitter.emit
  * @author Stefan Andjelkovic
+ * @since 0.1.0
  */
 inline fun <reified Q, reified U : Any> QueryUpdateEmitter.emit(update: U, noinline filter: (Q) -> Boolean) =
         this.emit(Q::class.java, filter, update)

kotlin/src/main/kotlin/org/axonframework/extensions/kotlin/ResultDiscriminatorCommandCallback.kt

@@ -28,6 +28,7 @@ import org.axonframework.messaging.MetaData
  * @param [C] the type of payload of the command
  * @see CommandCallback
  * @author Stefan Andjelkovic
+ * @since 0.1.0
  */
 class ResultDiscriminatorCommandCallback<C, R>(
     val onSuccess: (commandMessage: CommandMessage<out C>, result: R, metaData: MetaData) -> Unit,