methodComment

Sets the comment used for annotated methods.

Configuration Options

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

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

package com.example.persistence;

import javax.annotation.processing.Generated;

public class SomeRepository {

    @Generated(
        value = "YoSQL",
        date = "<current_timestamp>",
        comments = "DO NOT MODIFY - automatically generated by YoSQL"
    )
    public void someMethod() {
        // ... some code
    }

    // ... rest of generated code

}

Option: ‘Hello World!’

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

package com.example.persistence;

import javax.annotation.Generated;

public class SomeRepository {

    @Generated(
        value = "YoSQL",
        date = "<current_timestamp>",
        comments = "Hello World!"
    )
    public void someMethod() {
      // ... some code
    }

    // ... rest of generated code

}

Also in this group: annotateClasses , annotateFields , annotateMethods , annotationApi , classComment , classMembers , constructorAnnotations , fieldComment , fieldMembers , generatorName , methodAnnotations , methodMembers , repositoryAnnotations .

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-method-comment=configValue

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

yosql --method-comment=configValue

Gradle

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

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

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

or in Groovy syntax like this:

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

yosql {
  annotations {
    methodComment = configValue
  }
}

Maven

In order to use YoSQL together with Maven , take a look at the tooling documentation for Maven . The methodComment 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>
          <methodComment>configValue</methodComment>
        </annotations>
      </configuration>
    </plugin>
  </plugins>
</build>