[Chore] Clean up Javadocs

[dbwiddis]

/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/common/CommonValue.java:272: warning: no comment
    public static final String WORKFLOW_RESOURCE_TYPE = "workflow";
                               ^
/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/common/CommonValue.java:271: warning: no comment
    public static final String WORKFLOW_STATE_RESOURCE_TYPE = "workflow_state";
                               ^
/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/model/Config.java:109: warning: no main description
     * @return the masterKey
       ^
/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/model/Config.java:116: warning: no main description
     * @return the createTime
       ^
/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/model/Config.java:123: warning: no main description
     * @return the tenantId
       ^
/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/FlowFrameworkResourceSharingExtension.java:25: warning: use of default constructor, which does not provide a comment
public class FlowFrameworkResourceSharingExtension implements ResourceSharingExtension {
       ^
/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/util/PluginClient.java:40: warning: no comment
    public void setSubject(Subject subject) {
                ^
/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/transport/handler/SearchHandler.java:71: warning: no description for @param
     * @param resourceType
       ^
/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/workflow/ToolStep.java:41: warning: use of default constructor, which does not provide a comment
public class ToolStep implements WorkflowStep {
       ^
9 warnings

[HarshMehta112]

@dbwiddis Could you please share the branch name? I’m unable to find the code mentioned above in the main branch.

[dbwiddis]

@dbwiddis Could you please share the branch name? I’m unable to find the code mentioned above in the main branch.

The line numbers mentioned are part of the PR #1251 so some of those lines are applicable to that PR (CC: @DarshitChanpura)

But if you check out the main branch and run ./gradlew javadoc you'll get at least these 4 lines:

➜  flow-framework git:(main) ./gradlew javadoc
Starting a Gradle Daemon (subsequent builds will be faster)
=======================================
OpenSearch Build Hamster says Hello!
  Gradle Version        : 9.2.0
  OS Info               : Mac OS X 15.7.1 (aarch64)
  JDK Version           : 21 (Homebrew JDK 21 (21.0.9))
  JAVA_HOME             : /opt/homebrew/Cellar/openjdk@21/21.0.9/libexec/openjdk.jdk/Contents/Home
  Random Testing Seed   : 8EB043B28133F5AF
  Crypto Standard       : any-supported
=======================================

> Task :javadoc
/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/model/Config.java:109: warning: no main description
     * @return the masterKey
       ^
/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/model/Config.java:116: warning: no main description
     * @return the createTime
       ^
/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/model/Config.java:123: warning: no main description
     * @return the tenantId
       ^
/Users/widdisd/git/flow-framework/src/main/java/org/opensearch/flowframework/workflow/ToolStep.java:41: warning: use of default constructor, which does not provide a comment
public class ToolStep implements WorkflowStep {
       ^
4 warnings