api Issue 795: Add javadoc overview description with link to HTTP & OAuth projects

ngmiceli-g · ngmiceli-g · commit a86b492fb699 · 2013-09-11T21:08:35.000-04:00
https://codereview.appspot.com/13401049/
diff --git a/overview.html b/overview.html
@@ -0,0 +1,17 @@
+<html>
+  <body>
+    Written by Google, the <a href="https://code.google.com/p/google-api-java-client/">
+    google-api-java-client</a> library is an easy-to-use and efficient Java client library for
+    accessing Google APIs using JSON and OAuth 2.0.
+
+    <p>
+      This library is built on top of two common libraries, also built by Google, but designed to
+      work with any HTTP service on the web: the Google HTTP Client Library for Java and the Google
+      OAuth Client Library for Java.
+      @see <a href="http://javadoc.google-http-java-client.googlecode.com/hg/index.html">
+      Google HTTP Java Client Library Javadoc</a>
+      @see <a href="http://javadoc.google-oauth-java-client.googlecode.com/hg/index.html">
+      Google OAuth Java Client Library Javadoc</a>
+    </p>
+  </body>
+</html>
diff --git a/pom.xml b/pom.xml
@@ -465,6 +465,7 @@
                 <link>http://javadoc.google-oauth-java-client.googlecode.com/hg/${project.oauth.version}</link>
               </links>
               <doctitle>Google API Client Library for Java ${project.version}</doctitle>
+              <overview>${basedir}/overview.html</overview>
               <groups>
                 <group>
                   <title>google-api-client</title>
