doc: Add aggregate POM javadoc overview, title

jsonurl · Jul 13, 2020 · 275fefa · 275fefa
1 parent f032f4a
commit 275fefa
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 1 deletion.
diff --git a/pom.xml b/pom.xml
@@ -70,6 +70,14 @@
       <id>javadoc-site</id>
       <build>
         <defaultGoal>clean package javadoc:aggregate</defaultGoal>
+        <plugins>
+          <plugin>
+            <artifactId>maven-javadoc-plugin</artifactId>
+            <configuration>
+              <doctitle>JSON&#x2192;URL Java ${project.version} API</doctitle>
+            </configuration>
+          </plugin>
+        </plugins>
       </build>
     </profile>
 
@@ -90,7 +98,6 @@
               <scmBranch>gh-pages</scmBranch>
               <content>${project.reporting.outputDirectory}/apidocs</content>
               <checkinComment>doc: update by maven-scm-publish-plugin</checkinComment>
-              <!-- <serverId>github</serverId>  -->
               <ignorePathsToDelete>
                 <ignorePathsToDelete>.gitignore</ignorePathsToDelete>
                 <ignorePathsToDelete>.gitattributes</ignorePathsToDelete>

diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html
@@ -0,0 +1,40 @@
+<html>
+<!--
+  Copyright 2020 David MacCormack
+
+  Licensed under the Apache License, Version 2.0 (the "License"); you may not
+  use this file except in compliance with the License. You may obtain a copy
+  of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+ -->
+<body>
+    This API documentation includes the Javadocs for all Java artifacts in
+    <a href="https://search.maven.org/search?q=g:org.jsonurl">org.jsonurl</a> <var>groupId</var>.
+    <h2><a id="security" href="#security">Artifacts and Packages</a></h2>
+    <dl>
+      <dt>jsonurl-core</dt>
+      <dd>Provides the <a href="org/jsonurl/package-summary.html">org.jsonurl</a> package</dd>
+
+      <dt>jsonurl-jsonorg</dt>
+      <dd>Provides the <a href="org/jsonurl/jsonorg/package-summary.html">org.jsonurl.jsonorg</a> package</dd>
+
+      <dt>jsonurl-jsr374</dt>
+      <dd>Provides the <a href="org/jsonurl/jsonp/package-summary.html">org.jsonurl.jsonp</a> package</dd>
+    </dl>
+
+    <h2><a id="security" href="#security">Security</a></h2>
+    <p>The parser is designed to parse untrusted input. It supports limits on
+    the number of parsed values and depth of nested arrays or objects. When the
+    limit is exceeded a LimitException is thrown. Sane limit values are set by
+    default.
+
+</body>
+</html>