Fix javadoc generation (#126)

Signed-off-by: Nicola Isotta <[email protected]>

pom-dist.xml

@@ -648,11 +648,13 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.3.1</version>
+        <version>3.6.0</version>
         <configuration>
           <encoding>UTF-8</encoding>
           <sourcepath>${basedir}/target/sources_java8</sourcepath>
           <additionalOptions>-html4 -Xmaxwarns 1</additionalOptions>
+          <docfilessubdirs>true</docfilessubdirs>
+          <doclint>none</doclint>
         </configuration>
         <executions>
           <execution>

src/main/java/com/ibm/as400/access/list/package-info.java

@@ -0,0 +1,17 @@
+/**
+ * Provides classes that efficiently access lists of resources on an IBM i
+ * system.
+ *
+ * <P>
+ * Classes in this package are wrappers around the IBM i "Open List" (QGY)
+ * system APIs. A list of resources is compiled on the system to satisfy certain
+ * filter criteria. The list can then be accessed sequentially or randomly by
+ * the client.
+ * </P>
+ *
+ * <P>
+ * Users can implement their own Open List API wrappers by extending the
+ * com.ibm.as400.access.list.OpenList class.
+ * </P>
+ */
+package com.ibm.as400.access.list;

src/main/java/com/ibm/as400/access/package-info.java

@@ -0,0 +1,15 @@
+/**
+ * Provides classes that represent various IBM i data and resources.
+ *
+ * <P>
+ * These classes work with IBM i systems to provide an internet-enabled
+ * interface to access and update data and resources on the system.
+ * </P>
+ *
+ * <P>
+ * The access classes use the existing IBM i host servers as the access points
+ * to the system. Each host server runs in a separate job on the system, and
+ * sends and receives data streams on a socket connection.
+ * </P>
+ */
+package com.ibm.as400.access;

src/main/java/com/ibm/as400/data/package-info.java

@@ -0,0 +1,9 @@
+/**
+ * Provides classes to simplify calling IBM i programs (RPG, COBOL, C, etc) from Java.
+ * <p>
+ * The classes in this package use a technology called the
+ * <strong>Program Call Markup Language</strong>, or <strong>PCML</strong>. PCML
+ * is based on the Extensible Markup Language (XML) and defines the interface
+ * that is used when calling a program.
+ */
+package com.ibm.as400.data;

src/main/java/com/ibm/as400/resource/package-info.java

@@ -0,0 +1,23 @@
+/**
+ * <i>Deprecated</i> Provides classes that represent IBM i resources using a
+ * generic list-based scheme.
+ *
+ * <P>
+ * <b>This package has been deprecated</b>, and is no longer being enhanced.
+ * Users are advised to use packages <tt>com.ibm.as400.access</tt> and
+ * <tt>com.ibm.as400.access.list</tt> instead.
+ * </P>
+ *
+ * <P>
+ * These classes use buffering, transaction control, and list manipulation to
+ * improve the performance and manageability of lists of resources on the
+ * system.
+ * </P>
+ *
+ * <P>
+ * Some of the components in the com.ibm.as400.access package have counterparts
+ * that are represented as resources. For example, RJobList is the
+ * com.ibm.as400.resource version of the JobList class in the access package.
+ * </P>
+ */
+package com.ibm.as400.resource;

src/main/java/com/ibm/as400/security/auth/package-info.java

@@ -0,0 +1,42 @@
+/**
+ * Provides user profile swapping using IBM i profile token and credential
+ * classes.
+ *
+ * <P>
+ * These classes interact with the security services provided by IBM i.
+ * Specifically, support is provided to authenticate a user identity, sometimes
+ * referred to as a
+ * <I>principal</I>, and password against the native IBM i user registry. A
+ * credential representing the authenticated user can then be established. You
+ * can use the credential to alter the identity of the current IBM i thread to
+ * perform work under the authorities and permissions of the authenticated user.
+ * In effect, this identity swap results in the thread acting as if a sign-on
+ * was performed by the authenticated user.
+ * </P>
+ *
+ * <P>
+ * <B>Note:</B> The services to establish and swap credentials are only
+ * supported for OS/400 release V4R5M0 or greater.
+ * </P>
+ *
+ * <P>
+ * The AS400 class in the com.ibm.as400.access package now provides
+ * authentication for a given user profile and password against the IBM i
+ * system. You can also retrieve credentials representing authenticated user
+ * profiles and passwords for the system. These credentials, known as profile
+ * tokens, represent an authenticated user profile and password for a specific
+ * system. Profile tokens expire based on time, up to one hour, but can be
+ * refreshed in certain cases to provide an extended life span.
+ * </P>
+ *
+ * <P>
+ * <B>Note:</B> While inherently more secure than passing a user profile and
+ * password due to limited life span, profile tokens should still be considered
+ * sensitive information by the application and handled accordingly. Since the
+ * token represents an authenticated user and password, it could potentially be
+ * exploited by a hostile application to perform work on behalf of that user. It
+ * is ultimately the responsibility of the application to ensure that
+ * credentials are accessed in a secure manner.
+ * </P>
+ */
+package com.ibm.as400.security.auth;

src/main/java/com/ibm/as400/util/commtrace/package-info.java

@@ -0,0 +1,11 @@
+/**
+ * Provides a utility application and classes to assist in the formatting and
+ * display of IBM i communication traces.
+ *
+ * <P>
+ * These classes provide the ability to parse the data from an IBM i
+ * communication trace. Each class represents a specific portion of a packet of
+ * data. These classes parse data as defined by the respective RFCs.
+ * </P>
+ */
+package com.ibm.as400.util.commtrace;

src/main/java/com/ibm/as400/util/html/package-info.java

@@ -0,0 +1,23 @@
+/**
+ * Provides classes that assist in setting up forms and tables for HTML pages.
+ *
+ * <P>
+ * These classes provide representations for many common HTML tag elements. Each
+ * class produces an HTML tag for a specific element type that can be embedded
+ * into any HTML document. The tags that are generated are consistent with the
+ * HTML 3.2 specification.
+ * </P>
+ *
+ * <P>
+ * The HTML classes work with the com.ibm.as400.util.servlet classes to retrieve
+ * data from the IBM i system. They can also be used alone if the user supplies
+ * the table or form data.
+ * </P>
+ *
+ * <P>
+ * <B>Note:</B> The jt400Servlet.jar file includes both the HTML and Servlet
+ * classes. You must update your CLASSPATH to point to the jt400Servlet.jar file
+ * if you want to use the classes in the com.ibm.as400.util.html package.
+ * </P>
+ */
+package com.ibm.as400.util.html;

src/main/java/com/ibm/as400/util/package-info.java

@@ -0,0 +1,19 @@
+/**
+ * Provides various utility applications and classes.
+ *
+ * <P>
+ * This package currently provides the following utilities:
+ * <UL>
+ * <LI><B>AboutToolbox</B> - Prints the current version of the Toolbox that is
+ * found in the user's CLASSPATH.
+ * <LI><B>CommandHelpRetriever</B> - Allows you to generate HTML documentation
+ * for a given CL command (*CMD) name, library, and system. This function is
+ * available both as a Java program and as an application programming interface
+ * (API).
+ * <LI><B>JPing</B> - Allows you to remotely determine if the host server jobs
+ * that the Toolbox uses for communication are started and running on your IBM i
+ * system.
+ *
+ * </UL>
+ */
+package com.ibm.as400.util;

src/main/java/com/ibm/as400/util/servlet/package-info.java

@@ -0,0 +1,25 @@
+/**
+ * Provides classes that assist in writing servlets that manipulate IBM i data.
+ *
+ * <P>
+ * The servlet classes that are provided with the IBM Toolbox for Java work with
+ * the classes in the com.ibm.as400.access package to give you access to
+ * information located on the system. You decide how to use the servlet classes
+ * to assist you with your own servlet projects.
+ * </P>
+ *
+ * <P>
+ * A typical scenario is this: A web browser connects to the web server that is
+ * running the servlet. The jt400Servlet.jar and jt400Access.jar files reside on
+ * the web server because the servlet classes use some of the access classes to
+ * retrieve the data, and some of the HTML classes to present the data. The web
+ * server is connected to the IBM i system where the data is stored.
+ * </P>
+ *
+ * <P>
+ * <B>Note:</B> The jt400Servlet.jar file includes both the HTML and Servlet
+ * classes. You must update your CLASSPATH to point to the jt400Servlet.jar file
+ * if you want to use the classes in the com.ibm.as400.util.servlet package.
+ * </P>
+ */
+package com.ibm.as400.util.servlet;

src/main/java/com/ibm/as400/vaccess/package-info.java

@@ -0,0 +1,45 @@
+/**
+ * <i>Deprecated</i> Provides classes that graphically present IBM i data to the
+ * user.
+ *
+ * <P>
+ * <b>This package has been deprecated</b>, and is no longer being enhanced.
+ * Users are advised to build their own GUI applications using Java Swing, on
+ * top of the classes in package <tt>com.ibm.as400.access</tt>.
+ * </P>
+ *
+ * <P>
+ * These classes use the com.ibm.as400.access classes to retrieve data and then
+ * present that data to the user.
+ * </P>
+ *
+ * <P>
+ * The various pane classes are graphical user interface components that present
+ * and allow manipulation of one or more IBM i resources. The behavior of each
+ * resource varies depending on its type.
+ * </P>
+ *
+ * <P>
+ * All panes extend the javax.swing.JComponent class. As a result, they can be
+ * added to any AWT or Swing frame, window, or container.
+ * </P>
+ *
+ * IBM i resources are represented in the graphical user interface with an icon
+ * and text. IBM i resources are defined with hierarchical relationships where a
+ * resoure might have a parent and zero or more children. These are predefined
+ * relationships and are used to specify what resources are displayed in a pane.
+ * For example, VJobList is the parent to zero or more VJob objects, and this
+ * hierarchical relationship is represented graphically in a pane.
+ *
+ * <P>
+ * Java programs that use the IBM Toolbox for Java GUI (graphical user
+ * interface) classes need Swing 1.1. You get Swing 1.1 by running Java 2 or by
+ * downloading Swing 1.1 from Sun Microsystems, Inc. In the past, IBM Toolbox
+ * for Java has required Swing 1.0.3, and V4R5 is the first release that Swing
+ * 1.1 is supported. To move to Swing 1.1, some programming changes were made;
+ * therefore, you may have to make some programming changes as well. See the
+ * <A HREF="http://java.sun.com/products/jfc/index.jsp">
+ * Java Foundation Classes documentation</A> for more information about Swing.
+ * </P>
+ */
+package com.ibm.as400.vaccess;

src/main/java/utilities/package-info.java

@@ -0,0 +1,9 @@
+/**
+ * Provides various utility applications and classes.
+ * <p>
+ * <i>Warning: The JPing and AboutToolbox classes have been moved to
+ * com.ibm.as400.util. This "utility" package is deprecated and will be removed
+ * from the Java 9 version of the jar file.</i>
+ * </p>
+ */
+package utilities;