details:   https://code.openbravo.com/erp/devel/pi/rev/b87b8a66ba6b
changeset: 33668:b87b8a66ba6b
user:      Carlos Aristu <carlos.aristu <at> openbravo.com>
date:      Mon Mar 12 12:55:00 2018 +0100
summary:   related to issue 38066: javadoc improvements

diffstat:

 src-test/src/org/openbravo/test/datasource/BaseDataSourceTestDal.java |  19 
++++-----
 1 files changed, 9 insertions(+), 10 deletions(-)

diffs (57 lines):

diff -r aa980425cd68 -r b87b8a66ba6b 
src-test/src/org/openbravo/test/datasource/BaseDataSourceTestDal.java
--- a/src-test/src/org/openbravo/test/datasource/BaseDataSourceTestDal.java     
Mon Mar 12 12:42:12 2018 +0100
+++ b/src-test/src/org/openbravo/test/datasource/BaseDataSourceTestDal.java     
Mon Mar 12 12:55:00 2018 +0100
@@ -46,8 +46,7 @@
   protected static final String POST_METHOD = "POST";
 
   /**
-   * Performs a request to Openbravo returning its response and asserting the 
response code matches
-   * expectedResponse.
+   * @see BaseDataSourceTestDal#doRequest(String, String, int, String, String)
    */
   protected String doRequest(String wsPart, String content, int 
expectedResponse, String method)
       throws Exception {
@@ -55,8 +54,7 @@
   }
 
   /**
-   * Performs a request to Openbravo returning its response and asserting the 
response code matches
-   * expectedResponse.
+   * @see BaseDataSourceTestDal#doRequest(String, String, int, String, String)
    */
   protected String doRequest(String wsPart, Map<String, String> params, int 
expectedResponse,
       String method) throws Exception {
@@ -66,11 +64,10 @@
 
   /**
    * Performs a request to Openbravo returning its response and asserting the 
response code matches
-   * expectedResponse.
-   */
-  /**
-   * Performs a request to Openbravo returning its response and asserting the 
response code matches
-   * expectedResponse.
+   * expectedResponse. Before performing the requests, this method tries to 
authenticate with
+   * current settings if already not authenticated.
+   * 
+   * @return a {@code String} containing the response for the request
    */
   protected String doRequest(String wsPart, String content, int 
expectedResponse, String method,
       String contentType) throws Exception {
@@ -83,7 +80,7 @@
   /**
    * Performs a request to authenticate with current settings if already not 
authenticated.
    * 
-   * @return Sting with cookie with authenticated session id
+   * @return a {@code String} representing the cookie with authenticated 
session id
    * */
   protected String authenticate() throws Exception {
     if (!authenticated) {
@@ -96,6 +93,8 @@
   /**
    * Obtains URL of Openbravo instance, by default taken from 
Openbravo.poperties context.url
    * property
+   * 
+   * @return a {@code String} with the URL of Openbravo instance
    */
   protected String getOpenbravoURL() {
     if (OB_URL != null) {

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
Openbravo-commits mailing list
Openbravo-commits@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/openbravo-commits

Reply via email to