Made Javadoc review.

This commit is contained in:
Christian P. MOMON 2020-01-23 09:00:46 +01:00
parent 3c49266187
commit 7a7704fc12
3 changed files with 31 additions and 5 deletions

View File

@ -54,7 +54,12 @@ public class AgirStatool
private File targetDirectory; private File targetDirectory;
/** /**
* Instantiates a new AgirStatool. * Instantiates a new agir statool.
*
* @param connector
* the connector
* @param targetDirectory
* the target directory
*/ */
public AgirStatool(final Connection connector, final File targetDirectory) public AgirStatool(final Connection connector, final File targetDirectory)
{ {
@ -136,9 +141,11 @@ public class AgirStatool
} }
/** /**
* Builds the text project list. * Do build text project list.
* *
* @return the string list * @return the string list
* @throws AgirStatoolException
* the agir statool exception
*/ */
public StringList doBuildTextProjectList() throws AgirStatoolException public StringList doBuildTextProjectList() throws AgirStatoolException
{ {
@ -165,7 +172,10 @@ public class AgirStatool
} }
/** /**
* Clear all. * Do clear all pages.
*
* @throws AgirStatoolException
* the agir statool exception
*/ */
public void doClearAllPages() throws AgirStatoolException public void doClearAllPages() throws AgirStatoolException
{ {
@ -184,7 +194,10 @@ public class AgirStatool
} }
/** /**
* Refresh all. * Do refresh pages.
*
* @throws AgirStatoolException
* the agir statool exception
*/ */
public void doRefreshPages() throws AgirStatoolException public void doRefreshPages() throws AgirStatoolException
{ {
@ -522,6 +535,7 @@ public class AgirStatool
* *
* @return the projects * @return the projects
* @throws AgirStatoolException * @throws AgirStatoolException
* the agir statool exception
*/ */
public Projects listProjects() throws AgirStatoolException public Projects listProjects() throws AgirStatoolException
{ {
@ -850,6 +864,7 @@ public class AgirStatool
* @param projectId * @param projectId
* the project id * the project id
* @throws AgirStatoolException * @throws AgirStatoolException
* the agir statool exception
*/ */
public void refresh(final String projectId) throws AgirStatoolException public void refresh(final String projectId) throws AgirStatoolException
{ {

View File

@ -44,6 +44,15 @@ public class Project
/** /**
* Instantiates a new project. * Instantiates a new project.
*
* @param id
* the id
* @param identifier
* the identifier
* @param name
* the name
* @param parentId
* the parent id
*/ */
public Project(final long id, final String identifier, final String name, final Long parentId) public Project(final long id, final String identifier, final String name, final Long parentId)
{ {

View File

@ -148,12 +148,14 @@ public class CreatedConcludedCountChartView
} }
/** /**
* Builds the 3 months. * Builds the last months.
* *
* @param title * @param title
* the title * the title
* @param project * @param project
* the project * the project
* @param monthCount
* the month count
* @return the string * @return the string
* @throws AgirStatoolException * @throws AgirStatoolException
* the agir statool exception * the agir statool exception