You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2018/08/11 13:54:19 UTC
[juneau] branch master updated: Javadocs
This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/master by this push:
new 8314855 Javadocs
8314855 is described below
commit 8314855ece8e078de9fd5da4909e871d0c6055f8
Author: JamesBognar <ja...@apache.org>
AuthorDate: Sat Aug 11 09:54:04 2018 -0400
Javadocs
---
juneau-doc/src/main/javadoc/javadoc.css | 15 ++++++++++
juneau-doc/src/main/javadoc/overview.html | 35 ++++++++++++++--------
.../src/main/resources/ReleaseNotes/7.2.0.html | 2 +-
.../09.HttpPartAnnotations/08.Request.html | 18 +++++------
.../src/main/resources/overview-template.html | 6 ++--
5 files changed, 50 insertions(+), 26 deletions(-)
diff --git a/juneau-doc/src/main/javadoc/javadoc.css b/juneau-doc/src/main/javadoc/javadoc.css
index c77fc69..a1d2c62 100755
--- a/juneau-doc/src/main/javadoc/javadoc.css
+++ b/juneau-doc/src/main/javadoc/javadoc.css
@@ -678,9 +678,24 @@ h5.section {
margin: 10px 0 5px 0;
}
+h1.preview-title {
+ text-align:center;
+ padding:20px;
+ border-radius:15px;
+ color: red;
+ background-color:yellow;
+}
+
+h2.preview-section {
+ text-align:center;
+ padding:10px;
+ border-radius:15px;
+}
+
.new {
background-color:lightgreen;
}
+
.todo {
background-color:yellow;
}
diff --git a/juneau-doc/src/main/javadoc/overview.html b/juneau-doc/src/main/javadoc/overview.html
index 47cf591..4e0f8a9 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -43,9 +43,9 @@
</script>
</head>
<body>
-<h1 style='background-color: yellow;color:red;text-align:center;padding:20px;border-radius:15px;'>Apache Juneau 7.2.0 Documentation Preview</h1>
-<h2 class='todo' style='text-align:center;padding:10px;border-radius:15px;'>Documentation in progress</h2>
-<h2 class='new' style='text-align:center;padding:10px;border-radius:15px;'>New/updated documentation</h2>
+<h1 class='preview-title'>Apache Juneau 7.2.0 Documentation Preview</h1>
+<h2 class='preview-section todo'>Documentation in progress</h2>
+<h2 class='preview-section new'>New/updated documentation</h2>
<script type='text/javascript'>
function toggle(x) {
@@ -15638,10 +15638,10 @@ TODO(7.2.0)
<div class='topic'><!-- START: 7.9.8 - juneau-rest-server.HttpPartAnnotations.Request -->
<p>
The {@link org.apache.juneau.http.annotation.Request @Request} annotation can be applied to a parameter interface type of a <ja>@RestMethod</ja>-annotated method
- to identify it as an interface for retrieving HTTP parts through a bean interface.
+ to identify it as an interface for retrieving HTTP parts through a bean-like interface.
</p>
-<h5 class='section'>Example:</h5>
+<h5 class='figure'>Example:</h5>
<p class='bpcode w800'>
<ja>@RestMethod</ja>(path=<js>"/pets/{petId}"</js>)
<jk>public void</jk> putPet(UpdatePet updatePet) {...}
@@ -15663,11 +15663,22 @@ TODO(7.2.0)
}
</p>
<p>
- The return types of the getters must be the supported parameter types for the HTTP-part annotation used.
- <br>Schema-based serialization and parsing is used just as if used as individual parameter types.
+ The example above is identical in behavior to specifying individual annotated parameters on the <ja>@RestMethod</ja>-annotated method:
+</p>
+<p class='bpcode w800'>
+ <ja>@RestMethod</ja>(path=<js>"/pets/{petId}"</js>)
+ <jk>public void</jk> putPet(
+ <ja>@Path</ja>(<js>"petId"</js>) <jk>int</jk> petId,
+ <ja>@Query</ja>(<js>"verbose"</js>) <jk>boolean</jk> debug,
+ <ja>@Header</ja>(<js>"*"</js>) Map<String,Object> allHeaders,
+ <ja>@Body</ja> Pet pet
+ )
+ {...}
</p>
<p>
- It should be noted that the annotations used are the exact same used on REST parameters and have all the
+ The return types of the getters must be the supported parameter types for the HTTP-part annotation used.
+ <br>Schema-based serialization and parsing is used just as if used as individual parameter types.
+ <br>Annotations used are the exact same used on REST parameters and have all the
same feature support including automatic Swagger validation and documentation.
</p>
<h5 class='figure'>Example:</h5>
@@ -15692,12 +15703,10 @@ TODO(7.2.0)
}
</p>
<p>
- The <ja>@Request</ja> annotation can be defined on the parameter, class, or both.
+ For clarity, the <ja>@Request</ja> annotation can be defined on the parameter, class, or both.
</p>
-<h5 class='section'>Example:</h5>
+<h5 class='figure'>Example:</h5>
<p class='bpcode w800'>
- <jc>// @Request defined on both for clarity.</jc>
-
<ja>@RestMethod</ja>(path=<js>"/pets/{petId}"</js>)
<jk>public void</jk> putPet(<ja>@Request</ja> UpdatePet updatePet) {...}
@@ -30846,7 +30855,7 @@ TODO(7.2.0)
<br>Includes new methods on {@link org.apache.juneau.rest.RestRequest}:
<ul class='doctree'>
<li class='jm'>{@link org.apache.juneau.rest.RestRequest#getRequest(Class) getRequest(Class)}
- <li class='jm'>{@link org.apache.juneau.rest.RestRequest#getRequest(RequestMeta) getRequest(RequestMeta)}
+ <li class='jm'>{@link org.apache.juneau.rest.RestRequest#getRequest(RequestBeanMeta) getRequest(RequestBeanMeta)}
</ul>
<li>
New methods added to {@link org.apache.juneau.rest.widget.MenuItemWidget} to allow population of menu item content using Javascript and Ajax calls:
diff --git a/juneau-doc/src/main/resources/ReleaseNotes/7.2.0.html b/juneau-doc/src/main/resources/ReleaseNotes/7.2.0.html
index 7ab58ab..9356586 100644
--- a/juneau-doc/src/main/resources/ReleaseNotes/7.2.0.html
+++ b/juneau-doc/src/main/resources/ReleaseNotes/7.2.0.html
@@ -412,7 +412,7 @@
<br>Includes new methods on {@link org.apache.juneau.rest.RestRequest}:
<ul class='doctree'>
<li class='jm'>{@link org.apache.juneau.rest.RestRequest#getRequest(Class) getRequest(Class)}
- <li class='jm'>{@link org.apache.juneau.rest.RestRequest#getRequest(RequestMeta) getRequest(RequestMeta)}
+ <li class='jm'>{@link org.apache.juneau.rest.RestRequest#getRequest(RequestBeanMeta) getRequest(RequestBeanMeta)}
</ul>
<li>
New methods added to {@link org.apache.juneau.rest.widget.MenuItemWidget} to allow population of menu item content using Javascript and Ajax calls:
diff --git a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/09.HttpPartAnnotations/08.Request.html b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/09.HttpPartAnnotations/08.Request.html
index 25d3caa..9505b4c 100644
--- a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/09.HttpPartAnnotations/08.Request.html
+++ b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/09.HttpPartAnnotations/08.Request.html
@@ -20,7 +20,7 @@
to identify it as an interface for retrieving HTTP parts through a bean-like interface.
</p>
-<h5 class='section'>Example:</h5>
+<h5 class='figure'>Example:</h5>
<p class='bpcode w800'>
<ja>@RestMethod</ja>(path=<js>"/pets/{petId}"</js>)
<jk>public void</jk> putPet(UpdatePet updatePet) {...}
@@ -41,6 +41,9 @@
Pet getPet();
}
</p>
+<p>
+ The example above is identical in behavior to specifying individual annotated parameters on the <ja>@RestMethod</ja>-annotated method:
+</p>
<p class='bpcode w800'>
<ja>@RestMethod</ja>(path=<js>"/pets/{petId}"</js>)
<jk>public void</jk> putPet(
@@ -48,14 +51,13 @@
<ja>@Query</ja>(<js>"verbose"</js>) <jk>boolean</jk> debug,
<ja>@Header</ja>(<js>"*"</js>) Map<String,Object> allHeaders,
<ja>@Body</ja> Pet pet
- ) {...}
+ )
+ {...}
</p>
<p>
The return types of the getters must be the supported parameter types for the HTTP-part annotation used.
<br>Schema-based serialization and parsing is used just as if used as individual parameter types.
-</p>
-<p>
- It should be noted that the annotations used are the exact same used on REST parameters and have all the
+ <br>Annotations used are the exact same used on REST parameters and have all the
same feature support including automatic Swagger validation and documentation.
</p>
<h5 class='figure'>Example:</h5>
@@ -80,12 +82,10 @@
}
</p>
<p>
- The <ja>@Request</ja> annotation can be defined on the parameter, class, or both.
+ For clarity, the <ja>@Request</ja> annotation can be defined on the parameter, class, or both.
</p>
-<h5 class='section'>Example:</h5>
+<h5 class='figure'>Example:</h5>
<p class='bpcode w800'>
- <jc>// @Request defined on both for clarity.</jc>
-
<ja>@RestMethod</ja>(path=<js>"/pets/{petId}"</js>)
<jk>public void</jk> putPet(<ja>@Request</ja> UpdatePet updatePet) {...}
diff --git a/juneau-doc/src/main/resources/overview-template.html b/juneau-doc/src/main/resources/overview-template.html
index 1f6902b..5525645 100644
--- a/juneau-doc/src/main/resources/overview-template.html
+++ b/juneau-doc/src/main/resources/overview-template.html
@@ -43,9 +43,9 @@
</script>
</head>
<body>
-<h1 style='background-color: yellow;color:red;text-align:center;padding:20px;border-radius:15px;'>Apache Juneau 7.2.0 Documentation Preview</h1>
-<h2 class='todo' style='text-align:center;padding:10px;border-radius:15px;'>Documentation in progress</h2>
-<h2 class='new' style='text-align:center;padding:10px;border-radius:15px;'>New/updated documentation</h2>
+<h1 class='preview-title'>Apache Juneau 7.2.0 Documentation Preview</h1>
+<h2 class='preview-section todo'>Documentation in progress</h2>
+<h2 class='preview-section new'>New/updated documentation</h2>
<script type='text/javascript'>
function toggle(x) {