javadoc fixup

analysis: some fixup

Author: verhas

pom.xml

@@ -1,4 +1,5 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>com.scriptbasic</groupId>
@@ -43,6 +44,32 @@
     </properties>
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>3.0.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.0.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>

src/main/java/com/scriptbasic/api/BasicFunction.java

@@ -23,6 +23,8 @@
     /**
      * The alias name of the function to be used in the BASIC program. If this
      * is not defined then the name of the method will be used.
+     *
+     * @return value
      */
     String alias() default "";
 
@@ -69,13 +71,17 @@
      * <p>
      * The actual value of the actual version is defined as a constant:
      * {@link ExtensionInterfaceVersion#EXTENSION_INTERFACE_VERSION}.
+     *
+     * @return value
      */
     long requiredVersion() default 1;
 
     /**
      * The different methods can be classified and the configuration of the
      * actual interpreter registers or denies the registration of certain methods
      * based on the classification.
+     *
+     * @return value
      */
     Class<?>[] classification() default BasicFunction.class;
 
@@ -85,12 +91,16 @@
      * annotations. Using this annotation parameter you can specify an
      * alternative class where the method you want to register instead of the
      * annotated one is.
+     *
+     * @return value
      */
     Class<?> substituteClass() default BasicFunction.class;
 
     /**
      * Using this parameter you can specify an alternative method instead of the
      * annotated one. See the documentation of {@link #substituteClass()}.
+     *
+     * @return value
      */
     String substituteMethod() default "";
 }

src/main/java/com/scriptbasic/api/Configuration.java

@@ -73,7 +73,7 @@ default Stream<String> getConfigValueStream(final String key) {
      * using the notation {@code key}'.n' where 'n' starts with zero and should
      * increment by one continuously.
      *
-     * @param key
+     * @param key parameter
      * @return the list of configured strings
      */
     List<String> getConfigValueList(final String key);
@@ -95,20 +95,21 @@ default Stream<String> getConfigValueStream(final String key) {
     /**
      * Set the property value in the configuration. This method is available for host application to
      * configure the interpreter programmatically.
-     * @param name configuration property name
+     *
+     * @param name  configuration property name
      * @param value configuration property value
      */
     void set(final String name, final String value);
 
     /**
      * Set the property value in the configuration. This method is available for host application to
      * configure the interpreter programmatically.
+     *
      * @param command the name and the value separated by '='
      */
     void set(final String command);
 
     /**
-     *
      * @return the properties object that stores the configuration
      */
     Properties getConfigProperties();