[yetus] 02/03: YETUS-733. javadocs need to be written for shelldocs

[aw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

aw pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/yetus.git

commit 690d2df1c5db88c90ad4b957e4411566418806f5
Author: Allen Wittenauer <aw...@apache.org>
AuthorDate: Mon Dec 31 22:19:22 2018 -0800

    YETUS-733. javadocs need to be written for shelldocs
    
    Signed-off-by: Allen Wittenauer <aw...@apache.org>
---
 shelldocs/pom.xml                                       |  5 +++++
 .../main/java/org/apache/yetus/shelldocs/ShellDocs.java | 17 +++++++++++++++++
 2 files changed, 22 insertions(+)

diff --git a/shelldocs/pom.xml b/shelldocs/pom.xml
index c5c3ec3..0ba0b5c 100644
--- a/shelldocs/pom.xml
+++ b/shelldocs/pom.xml
@@ -39,6 +39,11 @@
       <artifactId>jython-shaded</artifactId>
       <version>${jython-shaded.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.apache.yetus</groupId>
+      <artifactId>audience-annotations</artifactId>
+      <version>${project.version}</version>
+    </dependency>
   </dependencies>
 
   <build>
diff --git a/shelldocs/src/main/java/org/apache/yetus/shelldocs/ShellDocs.java b/shelldocs/src/main/java/org/apache/yetus/shelldocs/ShellDocs.java
index facbc48..0ed6eff 100644
--- a/shelldocs/src/main/java/org/apache/yetus/shelldocs/ShellDocs.java
+++ b/shelldocs/src/main/java/org/apache/yetus/shelldocs/ShellDocs.java
@@ -26,7 +26,24 @@ import org.python.core.PyException;
 import org.python.core.PySystemState;
 import org.python.util.PythonInterpreter;
 
+import org.apache.yetus.audience.InterfaceAudience;
+import org.apache.yetus.audience.InterfaceStability;
+
+/**
+ * Jython-based interface to shelldocs.
+ */
+
 public class ShellDocs {
+  /**
+   *
+   * This method calls the main() method of the shelldocs Python program.
+   *
+   * @param args argument string
+   * @throws PyException standard exception thrown for Jython
+   */
+
+  @InterfaceAudience.Public
+  @InterfaceStability.Evolving
   public static void main(final String[] args) throws PyException {
     List<String> list = new LinkedList<String>(Arrays.asList(args));
     list.add(0,"shelldocs");