Details

    • Type: Technical task
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.0.0uimaFIT
    • Component/s: uimaFIT-Maven-Plugin
    • Labels:
      None

      Description

      Since the maven plugin runs at at build time and has access to the sources, this is a unique opportunity to extract descriptions of components and parameters from JavaDoc. The @ConfigurationParameter annotation provides for a description, but I always found it inconvenient to maintain the description twice, once in JavaDoc and once in the annotation. uimaFIT currently has no support for component descriptions.

      Often, the JavaDoc in uimaFIT components is not added do the parameter variable, but rather to the parameter name constant. So auto-completion in the IDE is use on PARAM_<ctrl-space>, it lists all the parameters along with their explanation.

      /**
       * A user-definable value.
       */
      public static final String PARAM_VALUE = "value";
      @ConfigurationParameter(name=PARAM_VALUE)
      private String value;
      

      For this reason, the maven plugin should support looking for parameter documentation not on a field, but rather look for a constant field in the component that starts with PARAM and has as value the name of the field - if such a constant is found, its JavaDoc should be used.

        Attachments

          Activity

            People

            • Assignee:
              rec Richard Eckart de Castilho
              Reporter:
              rec Richard Eckart de Castilho
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: