Skip to content

Commit

Permalink
chore(maintenance): fixed doclint complaints
Browse files Browse the repository at this point in the history
  • Loading branch information
swells committed Jun 28, 2016
1 parent 0c88374 commit 9a7aaab
Show file tree
Hide file tree
Showing 23 changed files with 59 additions and 60 deletions.
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ dependencies {

jar {
baseName = 'jDeployR'
version = '8.0.1'
version = '8.0.5'
}

javadoc {
Expand Down
2 changes: 1 addition & 1 deletion examples/tutorial/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dependencies {

jar {
baseName = 'client-tutorial'
version = '8.0.1'
version = '8.0.5'
}

task execute(type: JavaExec) {
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/com/revo/deployr/client/RClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public RUser login(RAuthentication pAuthentication, boolean disableautosave)
/**
* Execute a single repository-managed script or a chain of
* repository-managed scripts on an anonymous project.
* <p/>
* <p>
* To execute a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
Expand All @@ -86,7 +86,7 @@ public RScriptExecution executeScript(String scriptName,
/**
* Execute a single repository-managed script or a chain of
* repository-managed scripts on an anonymous project.
* <p/>
* <p>
* To execute a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
Expand All @@ -112,7 +112,7 @@ public RScriptExecution executeScript(String scriptName,
/**
* Execute a single repository-managed script or a chain of repository-managed scripts
* on an anonymous project.
* <p/>
* <p>
* To execute a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
Expand All @@ -134,7 +134,7 @@ public RScriptExecution executeScript(String scriptName,
/**
* Execute a single repository-managed script or a chain of repository-managed scripts
* on an anonymous project.
* <p/>
* <p>
* To execute a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
Expand All @@ -157,12 +157,12 @@ public RScriptExecution executeScript(String scriptName,
/**
* Execute a single script found on a URL/path or a chain of scripts found on a set of URLs/paths
* on an anonymous project.
* <p/>
* <p>
* To execute a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the externalSource parameter.
* Chained execution executes each of the scripts identified on the call in a sequential
* fashion on the R session, with execution occuring in the order specified on the parameter list.
* <p/>
* <p>
* POWER_USER privileges are required for this call.
*
* @throws RClientException if RClient fails to complete call.
Expand All @@ -179,14 +179,14 @@ public RScriptExecution executeExternal(String externalSource,
/**
* Execute a single repository-managed script or a chain of repository-managed scripts
* on an anonymous project and render the outputs to a HTML page.
* <p/>
* <p>
* To execute a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
* fashion on the R session, with execution occuring in the order specified on the parameter list.
*
* @throws RClientException if RClient fails to complete call.
* @throws RSecurityException if DeployR server security conditions not met on call.
* @throws RDataException if DeployR server security conditions not met on call.
* @see RScriptExecution
*/
public URL renderScript(String scriptName,
Expand Down
12 changes: 6 additions & 6 deletions src/main/java/com/revo/deployr/client/RProject.java
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,10 @@ public interface RProject extends

/**
* Recycle R session on project.
* <p/>
* <p>
* Recycles the R session associated with the project by deleting all
* R objects from the workspace and all files from the working directory.
* <p/>
* <p>
* Recommended for temporary and blackbox projects. Recycle persistent projects
* with caution as this operation can not be reversed.
*
Expand All @@ -130,16 +130,16 @@ public RProjectDetails recycle()

/**
* Recycle R session on project.
* <p/>
* <p>
* Recycles the R session associated with the project by deleting all
* R objects from the workspace and all files from the working directory.
* <p/>
* <p>
* Workspace objects and/or directory files can be preserved on a recycle
* by enabling the respective parameter.
* <p/>
* <p>
* Recycling a project is a convenient and efficient alternative to
* starting over by closing an existing project and then creating a new project.
* <p/>
* <p>
* Recommended for temporary and blackbox projects. Recycle persistent projects
* with caution as this operation can not be reversed.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public interface RRepositoryDirectory {

/**
* Update access-controls on files found in repository-managed user directory.
* <p/>
* <p>
* If the files parameter is null, all files in the directory are updated.
*
* @throws RClientException if RClient fails to complete call.
Expand Down Expand Up @@ -79,7 +79,7 @@ public RRepositoryDirectory rename(String newDirectoryName)

/**
* Download zip archive of files found in repository-managed user directory.
* <p/>
* <p>
* If the files parameter is null, all files in the directory are downloaded.
*
* @throws RClientException if RClient fails to complete call.
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/revo/deployr/client/about/RJobDetails.java
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public RJobDetails(String id, String name, String descr, String status, String s
/**
* Code execution time (millis) for job. Measures the time taken to
* execute the R code for the job.
* <p/>
* <p>
* Can be used in conjunction with timeStart and timeTotal to profile
* job runtime characteristics.
*/
Expand All @@ -104,7 +104,7 @@ public RJobDetails(String id, String name, String descr, String status, String s
* Total time (millis) for job. Measures the time taken to prepare
* R workspace and directory for job, execute code for the job and then
* persist job artifacts as a persistent project.
* <p/>
* <p>
* Can be used in conjunction with timeStart and timeCode to profile
* job runtime characteristics.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public RProjectExecutionDetails(String id, String code, long timeStart, long tim
/**
* Code execution time (millis) for execution. Measures the time taken to
* execute the R code for execution.
* <p/>
* <p>
* Can be used in conjunction with timeStart and timeTotal to profile
* execution runtime characteristics.
*/
Expand All @@ -72,7 +72,7 @@ public RProjectExecutionDetails(String id, String code, long timeStart, long tim
* Total time (millis) for execution. Measures the time taken to prepare
* R workspace and directory for execution, execute R code and then
* persist execution artifacts to on project.
* <p/>
* <p>
* Can be used in conjunction with timeStart and timeCode to profile
* execution runtime characteristics.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public RProjectExecution executeCode(String code,
/**
* Execute a single repository-managed script or a chain of
* repository-managed scripts on the current project.
* <p/>
* <p>
* To execute a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
Expand All @@ -74,7 +74,7 @@ public RProjectExecution executeScript(String scriptName,
/**
* Execute a single repository-managed script or a chain of
* repository-managed scripts on the current project.
* <p/>
* <p>
* To execute a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
Expand All @@ -99,7 +99,7 @@ public RProjectExecution executeScript(String scriptName,
/**
* Execute a single repository-managed script or a chain of repository-managed scripts
* on the current project.
* <p/>
* <p>
* To execute a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
Expand All @@ -120,7 +120,7 @@ public RProjectExecution executeScript(String scriptName,
/**
* Execute a single repository-managed script or a chain of repository-managed scripts
* on the current project.
* <p/>
* <p>
* To execute a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
Expand All @@ -142,12 +142,12 @@ public RProjectExecution executeScript(String scriptName,
/**
* Execute a single script found on a URL/path or a chain of scripts found on a set of URLs/paths
* on the current project.
* <p/>
* <p>
* To execute a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the externalSource parameter.
* Chained execution executes each of the scripts identified on the call in a sequential
* fashion on the R session, with execution occuring in the order specified on the parameter list.
* <p/>
* <p>
* POWER_USER privileges are required for this call.
*
* @throws RClientException if RClient fails to complete call.
Expand Down
14 changes: 7 additions & 7 deletions src/main/java/com/revo/deployr/client/api/RUserJobCalls.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public interface RUserJobCalls {
/**
* List jobs.
*
* @return List<RJob>
* @return List&lt;RJob&gt;
* @throws RClientException if RClient fails to complete call.
* @throws RSecurityException if DeployR server security conditions not met on call.
*/
Expand Down Expand Up @@ -72,7 +72,7 @@ public RJob submitJobCode(String jobName,
* Submit a single repository-managed script or a chain of
* repository-managed scripts (found in the root directory)
* to execute as a job.
* <p/>
* <p>
* To submit a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
Expand All @@ -96,7 +96,7 @@ public RJob submitJobScript(String jobName,
/**
* Submit a single repository-managed script or a chain of
* repository-managed scripts to execute as a job.
* <p/>
* <p>
* To submit a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
Expand All @@ -121,7 +121,7 @@ public RJob submitJobScript(String jobName,
/**
* Submit a single repository-managed script or a chain of repository-managed scripts
* to execute as a job.
* <p/>
* <p>
* To submit a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
Expand All @@ -142,7 +142,7 @@ public RJob submitJobScript(String jobName,
/**
* Submit a single repository-managed script or a chain of repository-managed scripts
* to execute as a job.
* <p/>
* <p>
* To submit a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters.
* Chained execution executes each of the scripts identified on the call in a sequential
Expand All @@ -164,10 +164,10 @@ public RJob submitJobScript(String jobName,
/**
* Submit a single script found on a URL/path or a chain of scripts found on a set of URLs/paths
* on the current project.
* <p/>
* <p>
* To submit a chain of repository-managed scripts on this call provide a comma-separated
* list of values on the externalSource parameter.
* <p/>
* <p>
* POWER_USER privileges are required for this call.
*
* @return RJob
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public RProject createProject(ProjectCreationOptions options)
/**
* Create a pool of temporary projects.
*
* @return List<RProject>
* @return List&lt;RProject&gt;
* @throws RClientException if RClient fails to complete call.
* @throws RSecurityException if DeployR server security conditions not met on call.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public RRepositoryDirectory createDirectory(String directory)
/**
* Copies one or more repository-managed files from a source
* user directory to a destination user directory.
* <p/>
* <p>
* If the files parameter is null, all files in the source
* directory will be copied to the destination directory.
*
Expand All @@ -150,7 +150,7 @@ public void copyDirectory(String sourceDirectory,
/**
* Moves one or more repository-managed files from a source
* user directory to a destination user directory.
* <p/>
* <p>
* If the files parameter is null, all files in the source
* directory will be moved to the destination directory.
*
Expand All @@ -166,7 +166,7 @@ public void moveDirectory(String sourceDirectory,
* Uploads a set of files in a single zip archive into an existing
* repository-managed user directory. The files are extracted from
* the zip archive and placed file-by-file into the directory.
* <p/>
* <p>
* The options.filename property is ignored on this call and
* can be left blank.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public interface RUserRepositoryScriptCalls {
/**
* List scripts in user' default repository.
*
* @return List<RRepositoryFile>
* @return List&lt;RRepositoryFile&gt;
* @throws RClientException if RClient fails to complete call.
* @throws RSecurityException if DeployR server security conditions not met on call.
*/
Expand Down Expand Up @@ -64,7 +64,7 @@ public List<RRepositoryFile> listScripts(String filename,
/**
* List scripts in user' external repository.
*
* @return List<RRepositoryFile>
* @return List&lt;RRepositoryFile&gt;
* @throws RClientException if RClient fails to complete call.
* @throws RSecurityException if DeployR server security conditions not met on call.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public interface RBooleanMatrix extends RData {
/**
* Gets the List-of-List of Boolean values for this RData.
*
* @return List<List<Boolean>> value
* @return List&lt;List&lt;Boolean&gt;&gt; value
* @see RData
*/
public List<List<Boolean>> getValue();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public interface RBooleanVector extends RData {
/**
* Gets the List of Boolean values for this RData.
*
* @return List<Boolean> value
* @return List&lt;Boolean&gt; value
* @see RData
*/
public List<Boolean> getValue();
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/revo/deployr/client/data/RDataFrame.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public interface RDataFrame extends RData {
/**
* Gets the List-of-RData value for this RData.
*
* @return List<RData> value
* @return List&lt;RData&gt; value
* @see RData
*/
public List<RData> getValue();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public interface RDateVector extends RData {
/**
* Gets the List of Date values for this RData.
*
* @return List<Date> value
* @return List&lt;Date&gt; value
* @see RData
*/
public List<Date> getValue();
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/revo/deployr/client/data/RList.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public interface RList extends RData {
/**
* Gets the List-of-RData value for this RData.
*
* @return List<RData> value
* @return List&lt;RData&gt; value
* @see RData
*/
public List<RData> getValue();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public interface RNumericMatrix extends RData {
/**
* Gets the List-of-List of Double values for this RData.
*
* @return List<List<Double>> value
* @return List&lt;List&lt;Double&gt;&gt; value
* @see RData
*/
public List<List<Double>> getValue();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public interface RNumericVector extends RData {
/**
* Gets the List of Double values for this RData.
*
* @return List<Double> value
* @return List&lt;Double&gt; value
* @see RData
*/
public List<Double> getValue();
Expand Down
Loading

0 comments on commit 9a7aaab

Please sign in to comment.