Sets the comment used for annotated classes.

Configuration Options

Option: ‘DO NOT MODIFY - automatically generated by YoSQL’

The default value of the classComment configuration option is DO NOT MODIFY - automatically generated by YoSQL. Setting the option to PROCESSING_API therefore produces the same code generated as the default configuration.

package com.example.persistence;

import javax.annotation.processing.Generated;

@Generated(
    value = "YoSQL",
    date = "<current_timestamp>",
    comments = "DO NOT MODIFY - automatically generated by YoSQL"
)
public class SomeRepository {

    // ... rest of generated code

}

Option: ‘Hello World!’

Changing the classComment configuration option to Hello World! produces the following code:

package com.example.persistence;

import javax.annotation.Generated;

@Generated(
    value = "YoSQL",
    date = "<current_timestamp>",
    comments = "Hello World!"
)
public class SomeRepository {

    // ... rest of generated code (same as above)

}

Related Options

• annotateClasses: Controls whether Generated annotations should be added to the generated classes.
• annotateFields: Controls whether Generated annotations should be added to the generated fields.
• annotateMethods: Controls whether Generated annotations should be added to the generated methods.
• annotationApi: The annotation API to use.
• classMembers: The annotation members to use for classes.
• constructorAnnotations: The additional annotations to be placed on generated constructors.
• fieldComment: Sets the comment used for annotated fields.
• fieldMembers: The annotation members to use for fields.
• generatorName: The name of the code generator
• methodAnnotations: The additional annotations to be placed on generated methods.
• methodComment: Sets the comment used for annotated methods.
• methodMembers: The annotation members to use for methods.
• repositoryAnnotations: The additional annotations to be placed on generated repository classes.

Tooling

Ant

In order to use YoSQL together with Ant, take a look at the tooling documentation for Ant.

Bazel

In order to use YoSQL together with Bazel, take a look at the tooling documentation for Bazel.

CLI

In order to use YoSQL on the command line, take a look at the tooling documentation for CLI.

$ yosql --annotations-class-comment=configValue

As long as the name of the config option is unique across all configuration groups, you can use the shorter form:

$ yosql --class-comment=configValue

Gradle

In order to use YoSQL together with Gradle, take a look at the tooling documentation for Gradle. The classComment setting can be configured using Gradle in Kotlin syntax like this:

plugins {
  java
  id("wtf.metio.yosql") version "2023.2.22"
}

yosql {
  annotations {
    classComment.set(configValue)
  }
}

or in Groovy syntax like this:

plugins {
  id "java"
  id "wtf.metio.yosql" version "2023.2.22"
}

yosql {
  annotations {
    classComment = configValue
  }
}

Maven

In order to use YoSQL together with Maven, take a look at the tooling documentation for Maven. The classComment setting can be configured using Maven like this:

<build>
  <plugins>
    <plugin>
      <groupId>wtf.metio.yosql</groupId>
      <artifactId>yosql-tooling-maven</artifactId>
      <version>2023.2.22</version>
      <configuration>
        <annotations>
          <classComment>configValue</classComment>
        </annotations>
      </configuration>
    </plugin>
  </plugins>
</build>