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: Update Javadocs.
Date Mon, 05 Mar 2018 15:29:35 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 280e04d  Update Javadocs.
280e04d is described below

commit 280e04da223cab45b53cde6c2d2a89a11b43d99e
Author: JamesBognar <jamesbognar@apache.org>
AuthorDate: Mon Mar 5 10:29:34 2018 -0500

    Update Javadocs.
---
 content/site/apidocs/overview-summary.html | 63 +-----------------------------
 1 file changed, 2 insertions(+), 61 deletions(-)

diff --git a/content/site/apidocs/overview-summary.html b/content/site/apidocs/overview-summary.html
index e63b2f0..71f6352 100644
--- a/content/site/apidocs/overview-summary.html
+++ b/content/site/apidocs/overview-summary.html
@@ -16436,25 +16436,12 @@
    ) 
    <jk>public class</jk> ConfigResource <jk>extends</jk> BasicRestServlet
{ 
       
-      <jd>/** 
-      * [GET /] - Show contents of config file. 
-      * 
-      * <ja>@return</ja> The config file. 
-      * <ja>@throws</ja> Exception 
-      */</jd> 
       <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/"</js>,
description=<js>"Show contents of config file."</js>) 
       <jk>public</jk> ObjectMap getConfig() <jk>throws</jk> Exception
{
          <jk>return</jk> getServletConfig().getConfig().asMap();
       }
       
-      <jd>/** 
-      * [GET /edit] - Show config file edit page. 
-      * 
-      * <ja>@param</ja> req The HTTP request. 
-      * <ja>@return</ja> The config file as a reader resource. 
-      * <ja>@throws</ja> Exception 
-      */</jd> 
-      <ja>@RestMethod</ja>(name=<jsf>GET></jsf>, path="/edit",
description="Edit config file.")
+      <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/edit"</js>,
description=<js>"Edit config file."</js>)
       <jk>public</jk> Form getConfigEditForm(RestRequest req) <jk>throws</jk>
Exception {
          <jk>return</jk> <jsm>form</jsm>().id(<js>"form"</js>).action(<js>"servlet:/"</js>).method(<js>"POST"</js>).enctype(<js>"application/x-www-form-urlencoded"</js>).children(
             <jsm>div</jsm>()._class(<js>"data"</js>).children(
@@ -16470,13 +16457,6 @@
          );
       }
       
-      <jd>/** 
-      * [GET /{section}] - Show config file section. 
-      * 
-      * <ja>@param</ja> section The section name. 
-      * <ja>@return</ja> The config file section. 
-      * <ja>@throws</ja> Exception 
-      */</jd> 
       <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/{section}"</js>,

          description=<js>"Show config file section."</js>, 
          swagger=<ja>@MethodSwagger</ja>(
@@ -16489,14 +16469,6 @@
          <jk>return</jk> getSection(section); 
       } 
       
-      <jd>/** 
-      * [GET /{section}/{key}] - Show config file entry. 
-      * 
-      * <ja>@param</ja> section The section name. 
-      * <ja>@param</ja> key The section key. 
-      * <ja>@return</ja> The value of the config file entry. 
-      * <ja>@throws</ja> Exception 
-      */</jd> 
       <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/{section}/{key}"</js>,

          description=<js>"Show config file entry."</js>, 
          swagger=<ja>@MethodSwagger</ja>(
@@ -16510,13 +16482,6 @@
          <jk>return</jk> getSection(section).getString(key); 
       } 
       
-      <jd>/** 
-      * [POST /] - Sets contents of config file from a FORM post. 
-      * 
-      * <ja>@param</ja> contents The new contents of the config file. 
-      * <ja>@return</ja> The new config file contents. 
-      * <ja>@throws</ja> Exception 
-      */</jd> 
       <ja>@RestMethod</ja>(name=<jsf>POST</jsf>, path=<js>"/"</js>,

          description=<js>"Sets contents of config file from a FORM post."</js>,

          swagger=<ja>@MethodSwagger</ja>(
@@ -16529,13 +16494,6 @@
          <jk>return</jk> setConfigContents(<jk>new</jk> StringReader(contents));

       } 
       
-      <jd>/** 
-      * [PUT /] - Sets contents of config file. 
-      * 
-      * <ja>@param</ja> contents The new contents of the config file. 
-      * <ja>@return</ja> The new config file contents. 
-      * <ja>@throws</ja> Exception 
-      */</jd> 
       <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>, path=<js>"/"</js>,

          description=<js>"Sets contents of config file."</js>, 
          swagger=<ja>@MethodSwagger</ja>(
@@ -16548,14 +16506,6 @@
          <jk>return</jk> getServletConfig().getConfig().load(contents, <jk>true</jk>).asMap();
       } 
       
-      <jd>/** 
-      * [PUT /{section}] - Add or overwrite a config file section. 
-      * 
-      * <ja>@param</ja> section The section name. 
-      * <ja>@param</ja> contents The new contents of the config file section.

-      * <ja>@return</ja> The new section. 
-      * <ja>@throws</ja> Exception 
-      */</jd> 
       <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>, path=<js>"/{section}"</js>,

          description=<js>"Add or overwrite a config file section."</js>, 
          swagger=<ja>@MethodSwagger</ja>(
@@ -16570,15 +16520,6 @@
          <jk>return</jk> getSection(section); 
       } 
       
-      <jd>/** 
-      * [PUT /{section}/{key}] - Add or overwrite a config file entry. 
-      * 
-      * <ja>@param</ja> section The section name. 
-      * <ja>@param</ja> key The section key. 
-      * <ja>@param</ja> value The new value. 
-      * <ja>@return</ja> The new value. 
-      * <ja>@throws</ja> Exception 
-      */</jd> 
       <ja>@RestMethod</ja>(name=<jsf>PUT</jsf>, path=<js>"/{section}/{key}"</js>,

          description=<js>"Add or overwrite a config file entry."</js>, 
          swagger=<ja>@MethodSwagger</ja>(
@@ -16597,7 +16538,7 @@
       <jk>private</jk> ObjectMap getSection(String name) { 
          ObjectMap m = getServletConfig().getConfig().getSectionMap(name); 
          <jk>if</jk> (m == <jk>null</jk>) 
-            <jk>throw new</jk> RestException(SC_NOT_FOUND, <js>"Section
not found."</js>); 
+            <jk>throw new</jk> RestException(<jsf>SC_NOT_FOUND</jsf>,
<js>"Section not found."</js>); 
          <jk>return</jk> m; 
       } 
    }     

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

Mime
View raw message