juneau-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jamesbog...@apache.org
Subject [juneau-website] branch asf-site updated: Javadoc Updates.
Date Fri, 02 Feb 2018 20:30:17 GMT
This is an automated email from the ASF dual-hosted git repository.

jamesbognar pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/juneau-website.git


The following commit(s) were added to refs/heads/asf-site by this push:
     new dee6f67  Javadoc Updates.
dee6f67 is described below

commit dee6f6794fca928e89a4ac39039c33267362394f
Author: JamesBognar <jamesbognar@apache.org>
AuthorDate: Fri Feb 2 15:30:15 2018 -0500

    Javadoc Updates.
---
 .../RemoteableProxiesServerSide.1.png}             | Bin
 .../RemoteableProxiesServerSide.2.png}             | Bin
 .../RemoteableProxiesServerSide.3.png}             | Bin
 .../RemoteableProxiesServerSide.4.png}             | Bin
 .../RemoteableProxiesServerSide.5.png}             | Bin
 .../RemoteableProxiesServerSide.6.png}             | Bin
 .../apache/juneau/dto/swagger/package-summary.html |  19 +----
 .../apache/juneau/plaintext/package-summary.html   |   2 +-
 content/site/apidocs/overview-summary.html         |  82 +++++++--------------
 9 files changed, 30 insertions(+), 73 deletions(-)

diff --git a/content/site/apidocs/org/apache/juneau/rest/remoteable/doc-files/1.png b/content/site/apidocs/doc-files/RemoteableProxiesServerSide.1.png
similarity index 100%
rename from content/site/apidocs/org/apache/juneau/rest/remoteable/doc-files/1.png
rename to content/site/apidocs/doc-files/RemoteableProxiesServerSide.1.png
diff --git a/content/site/apidocs/org/apache/juneau/rest/remoteable/doc-files/2.png b/content/site/apidocs/doc-files/RemoteableProxiesServerSide.2.png
similarity index 100%
rename from content/site/apidocs/org/apache/juneau/rest/remoteable/doc-files/2.png
rename to content/site/apidocs/doc-files/RemoteableProxiesServerSide.2.png
diff --git a/content/site/apidocs/org/apache/juneau/rest/remoteable/doc-files/3.png b/content/site/apidocs/doc-files/RemoteableProxiesServerSide.3.png
similarity index 100%
rename from content/site/apidocs/org/apache/juneau/rest/remoteable/doc-files/3.png
rename to content/site/apidocs/doc-files/RemoteableProxiesServerSide.3.png
diff --git a/content/site/apidocs/org/apache/juneau/rest/remoteable/doc-files/4.png b/content/site/apidocs/doc-files/RemoteableProxiesServerSide.4.png
similarity index 100%
rename from content/site/apidocs/org/apache/juneau/rest/remoteable/doc-files/4.png
rename to content/site/apidocs/doc-files/RemoteableProxiesServerSide.4.png
diff --git a/content/site/apidocs/org/apache/juneau/rest/remoteable/doc-files/5.png b/content/site/apidocs/doc-files/RemoteableProxiesServerSide.5.png
similarity index 100%
rename from content/site/apidocs/org/apache/juneau/rest/remoteable/doc-files/5.png
rename to content/site/apidocs/doc-files/RemoteableProxiesServerSide.5.png
diff --git a/content/site/apidocs/org/apache/juneau/rest/remoteable/doc-files/6.png b/content/site/apidocs/doc-files/RemoteableProxiesServerSide.6.png
similarity index 100%
rename from content/site/apidocs/org/apache/juneau/rest/remoteable/doc-files/6.png
rename to content/site/apidocs/doc-files/RemoteableProxiesServerSide.6.png
diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/package-summary.html b/content/site/apidocs/org/apache/juneau/dto/swagger/package-summary.html
index 0ef185a..3a9d94d 100644
--- a/content/site/apidocs/org/apache/juneau/dto/swagger/package-summary.html
+++ b/content/site/apidocs/org/apache/juneau/dto/swagger/package-summary.html
@@ -189,24 +189,7 @@
 <!--   -->
 </a>
 <h2 title="Package org.apache.juneau.dto.swagger Description">Package org.apache.juneau.dto.swagger
Description</h2>
-<div class="block"><p>Swagger Data Transfer Objects</p>
-<script>
-   function toggle(x) {
-      var div = x.nextSibling;
-      while (div != null && div.nodeType != 1)
-         div = div.nextSibling;
-      if (div != null) {
-         var d = div.style.display;
-         if (d == 'block' || d == '') {
-            div.style.display = 'none';
-            x.className += " closed";
-         } else {
-            div.style.display = 'block';
-            x.className = x.className.replace(/(?:^|\s)closed(?!\S)/g , '' );
-         }
-      }
-   }
-</script></div>
+<div class="block">Swagger Data Transfer Objects</div>
 </div>
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
diff --git a/content/site/apidocs/org/apache/juneau/plaintext/package-summary.html b/content/site/apidocs/org/apache/juneau/plaintext/package-summary.html
index eb6965f..9d61ec8 100644
--- a/content/site/apidocs/org/apache/juneau/plaintext/package-summary.html
+++ b/content/site/apidocs/org/apache/juneau/plaintext/package-summary.html
@@ -130,7 +130,7 @@
 <!--   -->
 </a>
 <h2 title="Package org.apache.juneau.plaintext Description">Package org.apache.juneau.plaintext
Description</h2>
-<div class="block"><p>Plaintext Marshalling Support</p></div>
+<div class="block">Plaintext Marshalling Support</div>
 </div>
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
diff --git a/content/site/apidocs/overview-summary.html b/content/site/apidocs/overview-summary.html
index 55dd53a..f3ec54e 100644
--- a/content/site/apidocs/overview-summary.html
+++ b/content/site/apidocs/overview-summary.html
@@ -1023,15 +1023,6 @@
             <br>Extensible support for other data types such as <code>Calendars</code>,
<code>Dates</code>, 
             <code>Iterators</code> is available through the use of POJO swaps
(described later).
          </p>
-         
-         <h5 class='toc'>Additional Information - org.apache.juneau.serializer</h5>
-         <ol class='toc'>
-            <li><p><a class='doclink' href='org/apache/juneau/serializer/package-summary.html#Serializer'>Serializer
API</a></p>
-            <ol>
-               <li><p><a class='doclink' href='org/apache/juneau/serializer/package-summary.html#SerializerGroup'>The
SerializerGroup class</a></p>
-            </ol>
-            <li><p><a class='doclink' href='org/apache/juneau/serializer/package-summary.html#DefiningSerializer'>Defining
a new Serializer</a></p>
-         </ol>
       </div>
       
       <!-- =======================================================================================================
-->
@@ -1111,15 +1102,6 @@
                Many of the JSON examples provided will use lax syntax which is easier to
read since we don't have to deal 
                with escapes.  
          </ul>
-         
-         <h5 class='toc'>Additional Information - org.apache.juneau.parser</h5>
-         <ol class='toc'>
-            <li><p><a class='doclink' href='org/apache/juneau/parser/package-summary.html#Parser'>Parser
API</a></p>
-            <ol>
-               <li><p><a class='doclink' href='org/apache/juneau/parser/package-summary.html#ParserGroup'>The
ParserGroup class</a></p>
-            </ol>
-            <li><p><a class='doclink' href='org/apache/juneau/parser/package-summary.html#DefiningParser'>Defining
a new Parser</a></p>
-         </ol>
       </div>
       
       <!-- =======================================================================================================
-->
@@ -1763,8 +1745,7 @@
                Several <code>PojoSwaps</code> are already provided for common
Java objects:
             </p>
             <ul class='doctree'>
-               <li class='jp'>
-                  <a class='doclink' href='org/apache/juneau/transforms/package-summary.html#TOC'>org.apache.juneau.transforms</a>
+               <li class='jp'><jk>org.apache.juneau.transforms</jk>
                   <ul>
                      <li class='jc'>
                         <a href="org/apache/juneau/transforms/ByteArrayBase64Swap.html"
title="class in org.apache.juneau.transforms"><code>ByteArrayBase64Swap</code></a>
@@ -9149,7 +9130,7 @@
             <p>
                If you point your browser to that URL, you get a list of available interfaces:
             </p>
-            <img class='bordered' src="doc-files/1.png">
+            <img class='bordered' src="doc-files/RemoteableProxiesServerSide.1.png">
             <p>
                Clicking the hyperlinks on each shows you the list of methods that can be
invoked on that service.
                Note that the <code>IAddressBook</code> link shows that you can
only invoke methods defined on that
@@ -9157,8 +9138,8 @@
                Since <code>AddressBook</code> extends from <code>LinkedList</code>,
you may notice familiar collections
                framework methods listed.
             </p>
-            <img class='bordered' src="doc-files/2.png">
-            <img class='bordered' src="doc-files/3.png">
+            <img class='bordered' src="doc-files/RemoteableProxiesServerSide.2.png">
+            <img class='bordered' src="doc-files/RemoteableProxiesServerSide.3.png">
             <p>
                Let's see how we can interact with this interface through nothing more than
REST calls to get a better idea on 
                how this works.
@@ -9207,12 +9188,12 @@
                We also want the results to be returned as JSON, so we set the <code>Accept</code>
header to 
                <code>text/json</code> as well.
             </p>
-            <img class='bordered' src="doc-files/4.png">
+            <img class='bordered' src="doc-files/RemoteableProxiesServerSide.4.png">
             <p>
                When we execute the POST, we should see the following successful response
whose body contains the returned 
                <code>Person</code> bean serialized to JSON:
             </p>
-            <img class='bordered' src="doc-files/5.png">
+            <img class='bordered' src="doc-files/RemoteableProxiesServerSide.5.png">
             <p>
                From there, we could use the following code snippet to reconstruct the response
object from JSON:
             </p>
@@ -9238,7 +9219,7 @@
                returned POJO (in this case as HTML since that's what's in the <code>Accept</code>
header when calling from a 
                browser):
             </p>
-            <img class='bordered' src="doc-files/6.png">
+            <img class='bordered' src="doc-files/RemoteableProxiesServerSide.6.png">
             <p>
                When specifying the POST body as a <code>&amp;content</code>
parameter, the method arguments should be in UON 
                notation.
@@ -9682,11 +9663,6 @@
                <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true"
title="class or interface in java.io"><code>InputStream</code></a> 
                - Returns access to the raw input stream of the response.
          </ul>
-   
-         <h5 class='toc'>Additional Information - org.apache.juneau.remoteable</h5>
-         <ol class='toc'>
-            <li><p><a class='doclink' href='org/apache/juneau/remoteable/package-summary.html#Overview'>Remoteable
support overview</a></p> 
-         </ol>
       </div>
 
    </div>
@@ -10372,13 +10348,11 @@
                <br>Identical to <l>doGetExample1()</l> but uses automatically
resolved parameters based on class type.
                <br>Juneau automatically recognizes specific class types such as common
header types and automatically
                resolves them to objects for you.  
-               <br>See <a class='doclink' 
-               href='org/apache/juneau/rest/package-summary.html#RestResources.MethodSignature'>Rest
Resources / 
-               Method Signature</a> for the list of all automatically support parameter
types, and 
+               <br>See <a class='doclink' href='#juneau-rest-server.RestMethod'>@RestMethod</a>
for the list of all automatically support parameter types, and 
                <a href="org/apache/juneau/rest/annotation/RestResource.html#paramResolvers--"><code>@RestResource.paramResolvers()</code></a>
                for defining your own custom parameter type resolvers. 
          </ul>
-         
+         <xxx>
          <p>
             There's a lot going on in this method.  
             Notice how you're able to access URL attributes, parameters, headers, and content
as parsed POJOs.  
@@ -13783,7 +13757,7 @@
                <li><p><a class='doclink' href='#juneau-marshall.URIs'>URIs</a></p>
                <li><p><a class='doclink' href='#juneau-marshall.BeanFilters'>BeanFilters</a></p>
                <li><p><a class='doclink' href='#juneau-marshall.StopClasses'>Stop
Classes</a></p>
-               <li><p><a class='doclink' href='##juneau-marshall.BypassSerialization'>Bypass
Serialization</a></p>
+               <li><p><a class='doclink' href='#juneau-marshall.BypassSerialization'>Bypass
Serialization</a></p>
             </ul>    
          <li>
             Updated javadocs:
@@ -14322,9 +14296,9 @@
          <li>
             New class: <a href="org/apache/juneau/utils/PojoMerge.html" title="class in
org.apache.juneau.utils"><code>PojoMerge</code></a>
          <li>
-            New doc: <a class='doclink' href='#juneau-marshall.PojoAnnotation'>2.6.2
- @Pojo annotation</a>
+            New doc: <del>2.6.2 - @Pojo annotation</del>
          <li>
-            New doc: <a class='doclink' href='#juneau-marshall.SerializingReadersAndInputStreams'>2.6.5
- Serializing Readers and InputStreams</a>
+            New doc: <del>2.6.5 - Serializing Readers and InputStreams</del>
       </ul>
       
       <h5 class='topic'>juneau-dto</h5>
@@ -14420,7 +14394,7 @@
          <li>
             Stylesheet selection now stored in HTTP session when passed in via <code>?stylesheet</code>
query parameter.
          <li>
-            New doc: <a class='doclink' href='/org/apache/juneau/rest/package-summary.html#RestResources.RestHooks'>Lifecycle
Hooks</a>
+            New doc: <del>Lifecycle Hooks</del>
          <li>
             Eliminated the <code>RestServletJenaDefault</code> class to remove
the Jena dependency class on 
             the <code>juneau-rest-server</code> artifact. 
@@ -15155,7 +15129,7 @@
             <ul>
                <li>New <a href="org/apache/juneau/dto/swagger/SwaggerBuilder.html"
title="class in org.apache.juneau.dto.swagger"><code>SwaggerBuilder</code></a>
class.
                <li>Fluent-style setters added to the Swagger beans.
-               <li>Added Swagger examples <code><del>here</del></code>
and in the <a class='doclink' href='org/apache/juneau/dto/swagger/package-summary.html#TOC'>org.apache.juneau.dto.swagger</a>
javadocs.
+               <li>Added Swagger examples <code><del>here</del></code>
and in the <del>org.apache.juneau.dto.swagger</del> javadocs.
             </ul>
          <li>Improvements to <a href="org/apache/juneau/svl/VarResolver.html" title="class
in org.apache.juneau.svl"><code>VarResolver</code></a>.
             <ul>
@@ -15308,7 +15282,7 @@
       <h5 class='topic'>org.apache.juneau.rest.client</h5>
       <ul class='spaced-list'>
          <li>Revamped the client API to use builders.
-         <li>New doc: <a class='doclink' href='org/apache/juneau/rest/client/package-summary.html#Debugging'>1.5
- Debugging</a>
+         <li>New doc: <del>1.5 - Debugging</del>
          <li>The <code>RestClient</code> class <code>doX(Object url)</code>
methods now handle HttpClient <code>URIBuilder</code> instances.
          <li>New methods added/updated to <a href="org/apache/juneau/rest/client/RestClient.html"
title="class in org.apache.juneau.rest.client"><code>RestClient</code></a>:
          <ul>
@@ -16294,10 +16268,10 @@
          <li><a href='org/apache/juneau/microservice/package-summary.html#TOC'>org.apache.juneau.microservice</a>
- New package-level javadoc.
          <li><a href='org/apache/juneau/ini/package-summary.html#TOC'>org.apache.juneau.ini</a>
- New package-level javadoc.
          <li><del><code>StringVarResolver</code></del> - New
documentation.
-         <li><a href='org/apache/juneau/client/package-summary.html#TOC'>org.apache.juneau.rest.client</a>
- New package-level javadoc.
+         <li><a href='org/apache/juneau/rest/client/package-summary.html#TOC'>org.apache.juneau.rest.client</a>
- New package-level javadoc.
          <li><code><del>Overview / Samples</del></code> - New
section.
-         <li><a href='org/apache/juneau/transform/package-summary.html#StopClasses'>org.apache.juneau.transform
/ Stop Classes</a> - New section.
-         <li><a href='org/apache/juneau/server/package-summary.html#TOC'>org.apache.juneau.rest</a>
- Extensive updates.
+         <li><del>org.apache.juneau.transform / Stop Classes</del> - New
section.
+         <li><del>org.apache.juneau.rest</del> - Extensive updates.
       </ul>
    </div>
    
@@ -16378,7 +16352,7 @@
             Allows encoders to be fine-tuned at the method level.
          <li>New <a href="org/apache/juneau/rest/annotation/RestResource.html#config--"><code>@RestResource.config()</code></a>
annotation for associating external <a href="org/apache/juneau/ini/ConfigFile.html" title="class
in org.apache.juneau.ini"><code>ConfigFile</code></a> config files with
servlets.
          <li><code><del>ResourceLink</del></code>.
-         <li>New <a class='doclink' href='org/apache/juneau/rest/matchers/package-summary.html#TOC'>org.apache.juneau.rest.matchers</a>
package for commonly-used <a href="org/apache/juneau/rest/RestMatcher.html" title="class
in org.apache.juneau.rest"><code>RestMatchers</code></a>:
+         <li>New <code>org.apache.juneau.rest.matchers</code> package for
commonly-used <a href="org/apache/juneau/rest/RestMatcher.html" title="class in org.apache.juneau.rest"><code>RestMatchers</code></a>:
             <ul>
                <li><a href="org/apache/juneau/rest/matchers/package-summary.html"><code>org.apache.juneau.rest.matchers</code></a>
                <li><a href="org/apache/juneau/rest/matchers/package-summary.html"><code>org.apache.juneau.rest.matchers</code></a>
@@ -16410,7 +16384,7 @@
       <h5 class='topic'>Core</h5>
       <ul class='spaced-list'>
          <li>Beans can now be serialized to and parsed from <a href="org/apache/juneau/ObjectMap.html"
title="class in org.apache.juneau"><code>ObjectMaps</code></a>.
-            See <a class='doclink' href='org/apache/juneau/transform/package-summary.html#ToObjectMaps'>Serializing
to ObjectMaps</a> for details.
+            See <del>Serializing to ObjectMaps</del> for details.
          <li>New <a href="org/apache/juneau/ObjectMap.html#include-java.lang.String...-"><code>ObjectMap.include(String[])</code></a>
and <a href="org/apache/juneau/ObjectMap.html#exclude-java.lang.String...-"><code>ObjectMap.exclude(String[])</code></a>
methods.
          <li><a href="org/apache/juneau/html/annotation/Html.html" title="annotation
in org.apache.juneau.html.annotation"><code>@Html</code></a> annotations
can now be applied to bean properties.
          <li>New <a href="org/apache/juneau/utils/IOPipe.html" title="class in org.apache.juneau.utils"><code>IOPipe</code></a>
utility class.
@@ -16428,7 +16402,7 @@
          <li>New <code>RestResponse.getUnbufferedWriter()</code> method.
          <li>Fixed bug that was preventing <code>x-response-headers</code>
parameter from working correctly.
          <li>Added <a href="org/apache/juneau/annotation/Bean.html#properties--"><code>@Bean.properties</code></a>
annotations to the various 
-            classes in <a class='doclink' href='org/apache/juneau/rest/labels/package-summary.html#TOC'>org.apache.juneau.rest.labels</a>
so that the order of the bean properties are consistent
+            classes in <code>org.apache.juneau.rest.labels</code> so that the
order of the bean properties are consistent
             on all JVMs.  On IBM JVMs this is unnecessary because the order of the properties
as defined in the class
             are stored in the bytecode.  Other JVMs such as OpenJRE do not implement this
feature causing the bean
             properties to be in random order.
@@ -17982,7 +17956,7 @@
       <h5 class='topic'>Core API changes</h5>
       <ul class='spaced-list'>
          <li>
-            New <a class='doclink' href='org/apache/juneau/serializer/package-summary.html#TOC'>org.apache.juneau.serializer</a>
package.
+            New <code>org.apache.juneau.serializer</code> package.
             <ul>
                <li>Entirely reworked class hierarchy to make it easier to define new
serializers.</li>
                <li>New <a href="org/apache/juneau/serializer/WriterSerializer.html"
title="class in org.apache.juneau.serializer"><code>WriterSerializer</code></a>
base class for defining character-based serializers.</li>
@@ -17992,7 +17966,7 @@
             </ul>
             </li>
             <li>
-               New <a class='doclink' href='org/apache/juneau/parser/package-summary.html#TOC'>org.apache.juneau.parser</a>
package.
+               New <code>org.apache.juneau.parser</code> package.
                <ul>
                   <li>Entirely reworked class hierarchy to make it easier to define
new parsers.</li>
                <li>New <a href="org/apache/juneau/parser/ReaderParser.html" title="class
in org.apache.juneau.parser"><code>ReaderParser</code></a> base class
for defining character-based parsers.</li>
@@ -18001,7 +17975,7 @@
                </ul>
             </li>
             <li>
-            New <a class='doclink' href='org/apache/juneau/transform/package-summary.html#TOC'>org.apache.juneau.transform</a>
package.
+            New <code>org.apache.juneau.transform</code> package.
             <ul>
                <li>Cleaner class structure.</li>
                <li>Improved <a href="org/apache/juneau/transform/BeanFilter.html"
title="class in org.apache.juneau.transform"><code>BeanFilter</code></a>
class for defining property filters on beans.</li>
@@ -18009,7 +17983,7 @@
                </ul>
             </li>
             <li>
-            New <a class='doclink' href='org/apache/juneau/encoders/package-summary.html#TOC'>org.apache.juneau.encoders</a>
package.
+            New <code>org.apache.juneau.encoders</code> package.
             <ul>
                <li>Defines API for <a href="org/apache/juneau/encoders/Encoder.html"
title="class in org.apache.juneau.encoders"><code>Encoders</code></a>
for enabling compression in REST servlets and clients.</li>
                <li>Previously, gzip compression was enabled by default.  This new API
allows you to plug in your own compression algorithms.</li>
@@ -18018,19 +17992,19 @@
             </ul>
          </li>
          <li>
-            New <a class='doclink' href='org/apache/juneau/plaintext/package-summary.html#TOC'>org.apache.juneau.plaintext</a>
package.
+            New <code>org.apache.juneau.plaintext</code> package.
             <ul>
                <li>New <a href="org/apache/juneau/plaintext/PlainTextSerializer.html"
title="class in org.apache.juneau.plaintext"><code>PlainTextSerializer</code></a>
and <a href="org/apache/juneau/plaintext/PlainTextParser.html" title="class in org.apache.juneau.plaintext"><code>PlainTextParser</code></a>
classes for serializing/parsing text/plain content.</li>
             </ul>
          </li>
          <li>
-            New <a class='doclink' href='org/apache/juneau/jso/package-summary.html#TOC'>org.apache.juneau.jso</a>
package.
+            New <code>org.apache.juneau.jso</code> package.
             <ul>
                <li>New <a href="org/apache/juneau/jso/JsoSerializer.html" title="class
in org.apache.juneau.jso"><code>JsoSerializer</code></a> class for serializing
<code>application/x-java-serialized-object</code> content.</li>
             </ul>
          </li>
          <li>
-            New <a class='doclink' href='org/apache/juneau/soap/package-summary.html#TOC'>org.apache.juneau.soap</a>
package.
+            New <code>org.apache.juneau.soap</code> package.
             <ul>
                <li>New <a href="org/apache/juneau/soap/SoapXmlSerializer.html" title="class
in org.apache.juneau.soap"><code>SoapXmlSerializer</code></a> class for
serializing <code>text/xml+soap</code> content.</li>
             </ul>

-- 
To stop receiving notification emails like this one, please contact
jamesbognar@apache.org.

Mime
View raw message