From 7a7704fc12b2e03bf540ec81a6c2d114d833b131 Mon Sep 17 00:00:00 2001 From: "Christian P. MOMON" Date: Thu, 23 Jan 2020 09:00:46 +0100 Subject: [PATCH] Made Javadoc review. --- .../april/agirstatool/core/AgirStatool.java | 23 +++++++++++++++---- src/org/april/agirstatool/core/Project.java | 9 ++++++++ .../pages/CreatedConcludedCountChartView.java | 4 +++- 3 files changed, 31 insertions(+), 5 deletions(-) diff --git a/src/org/april/agirstatool/core/AgirStatool.java b/src/org/april/agirstatool/core/AgirStatool.java index a87026e..e0e56f0 100644 --- a/src/org/april/agirstatool/core/AgirStatool.java +++ b/src/org/april/agirstatool/core/AgirStatool.java @@ -54,7 +54,12 @@ public class AgirStatool 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) { @@ -136,9 +141,11 @@ public class AgirStatool } /** - * Builds the text project list. + * Do build text project list. * * @return the string list + * @throws AgirStatoolException + * the agir statool exception */ 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 { @@ -184,7 +194,10 @@ public class AgirStatool } /** - * Refresh all. + * Do refresh pages. + * + * @throws AgirStatoolException + * the agir statool exception */ public void doRefreshPages() throws AgirStatoolException { @@ -522,6 +535,7 @@ public class AgirStatool * * @return the projects * @throws AgirStatoolException + * the agir statool exception */ public Projects listProjects() throws AgirStatoolException { @@ -850,6 +864,7 @@ public class AgirStatool * @param projectId * the project id * @throws AgirStatoolException + * the agir statool exception */ public void refresh(final String projectId) throws AgirStatoolException { diff --git a/src/org/april/agirstatool/core/Project.java b/src/org/april/agirstatool/core/Project.java index 2b091b5..09f4ca1 100644 --- a/src/org/april/agirstatool/core/Project.java +++ b/src/org/april/agirstatool/core/Project.java @@ -44,6 +44,15 @@ public class 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) { diff --git a/src/org/april/agirstatool/core/pages/CreatedConcludedCountChartView.java b/src/org/april/agirstatool/core/pages/CreatedConcludedCountChartView.java index 427f18a..fb311c5 100644 --- a/src/org/april/agirstatool/core/pages/CreatedConcludedCountChartView.java +++ b/src/org/april/agirstatool/core/pages/CreatedConcludedCountChartView.java @@ -148,12 +148,14 @@ public class CreatedConcludedCountChartView } /** - * Builds the 3 months. + * Builds the last months. * * @param title * the title * @param project * the project + * @param monthCount + * the month count * @return the string * @throws AgirStatoolException * the agir statool exception