From bf7d0c7dbce2fd4b49cb73d06e4b60a0e111dae7 Mon Sep 17 00:00:00 2001 From: Filip Izydorczyk Date: Fri, 15 Jan 2021 16:24:29 +0100 Subject: [PATCH] Buisness logic docs packages --- .../src/main/java/com/plannaplan/api/package-info.java | 6 ++++++ .../main/java/com/plannaplan/configutils/package-info.java | 7 +++++++ .../main/java/com/plannaplan/entities/package-info.java | 6 ++++++ .../main/java/com/plannaplan/exceptions/package-info.java | 6 ++++++ .../src/main/java/com/plannaplan/models/MatchData.java | 3 ++- .../main/java/com/plannaplan/models/UserApiResponse.java | 2 +- .../src/main/java/com/plannaplan/models/package-info.java | 6 ++++++ .../com/plannaplan/repositories/AppConfigRepository.java | 3 +++ .../java/com/plannaplan/repositories/package-info.java | 7 +++++++ .../main/java/com/plannaplan/services/CourseService.java | 2 +- .../main/java/com/plannaplan/services/package-info.java | 7 +++++++ .../src/main/java/com/plannaplan/types/package-info.java | 6 ++++++ 12 files changed, 58 insertions(+), 3 deletions(-) create mode 100755 buisnesslogic/src/main/java/com/plannaplan/api/package-info.java create mode 100755 buisnesslogic/src/main/java/com/plannaplan/configutils/package-info.java create mode 100755 buisnesslogic/src/main/java/com/plannaplan/entities/package-info.java create mode 100755 buisnesslogic/src/main/java/com/plannaplan/exceptions/package-info.java create mode 100755 buisnesslogic/src/main/java/com/plannaplan/models/package-info.java create mode 100755 buisnesslogic/src/main/java/com/plannaplan/repositories/package-info.java create mode 100755 buisnesslogic/src/main/java/com/plannaplan/services/package-info.java create mode 100755 buisnesslogic/src/main/java/com/plannaplan/types/package-info.java diff --git a/buisnesslogic/src/main/java/com/plannaplan/api/package-info.java b/buisnesslogic/src/main/java/com/plannaplan/api/package-info.java new file mode 100755 index 0000000..9f88873 --- /dev/null +++ b/buisnesslogic/src/main/java/com/plannaplan/api/package-info.java @@ -0,0 +1,6 @@ +/** + * Provides the classes necessary to obtain usos authentication with Oauth1 + * + * @since 1.0 + */ +package com.plannaplan.api; diff --git a/buisnesslogic/src/main/java/com/plannaplan/configutils/package-info.java b/buisnesslogic/src/main/java/com/plannaplan/configutils/package-info.java new file mode 100755 index 0000000..15bfb00 --- /dev/null +++ b/buisnesslogic/src/main/java/com/plannaplan/configutils/package-info.java @@ -0,0 +1,7 @@ +/** + * Provides the classes necessary to to config and import related operations in + * the app + * + * @since 1.0 + */ +package com.plannaplan.configutils; diff --git a/buisnesslogic/src/main/java/com/plannaplan/entities/package-info.java b/buisnesslogic/src/main/java/com/plannaplan/entities/package-info.java new file mode 100755 index 0000000..eb30373 --- /dev/null +++ b/buisnesslogic/src/main/java/com/plannaplan/entities/package-info.java @@ -0,0 +1,6 @@ +/** + * Provides all entieites that are created in database by Hibernate + * + * @since 1.0 + */ +package com.plannaplan.entities; diff --git a/buisnesslogic/src/main/java/com/plannaplan/exceptions/package-info.java b/buisnesslogic/src/main/java/com/plannaplan/exceptions/package-info.java new file mode 100755 index 0000000..3676222 --- /dev/null +++ b/buisnesslogic/src/main/java/com/plannaplan/exceptions/package-info.java @@ -0,0 +1,6 @@ +/** + * Provides custom for our app exceptions to get more accutrate errors info + * + * @since 1.0 + */ +package com.plannaplan.exceptions; diff --git a/buisnesslogic/src/main/java/com/plannaplan/models/MatchData.java b/buisnesslogic/src/main/java/com/plannaplan/models/MatchData.java index 8054627..f0b7adf 100755 --- a/buisnesslogic/src/main/java/com/plannaplan/models/MatchData.java +++ b/buisnesslogic/src/main/java/com/plannaplan/models/MatchData.java @@ -79,7 +79,8 @@ public class MatchData { * Exchanges 12:00 and 12:00 * * @param m1 MatchData instance to compare to - * @return int <0 if m1 is "less than", 0 if it's equal and >0 otherwise + * @return int less than 0 if m1 is "less than", 0 if it's equal and more than 0 + * otherwise */ public int compare(MatchData m1) { return Long.compare(m1.getExchangesMsValue(), this.getExchangesMsValue()); diff --git a/buisnesslogic/src/main/java/com/plannaplan/models/UserApiResponse.java b/buisnesslogic/src/main/java/com/plannaplan/models/UserApiResponse.java index 0d2bf35..a7b2ecd 100755 --- a/buisnesslogic/src/main/java/com/plannaplan/models/UserApiResponse.java +++ b/buisnesslogic/src/main/java/com/plannaplan/models/UserApiResponse.java @@ -39,7 +39,7 @@ public class UserApiResponse { * setter for surname. Reson to have setters for this class is for case if there * would be name and no surname or otherwise * - * @param surname name to set that was obtained by api request + * @param name name to set that was obtained by api request */ public void setName(String name) { this.name = name; diff --git a/buisnesslogic/src/main/java/com/plannaplan/models/package-info.java b/buisnesslogic/src/main/java/com/plannaplan/models/package-info.java new file mode 100755 index 0000000..9055071 --- /dev/null +++ b/buisnesslogic/src/main/java/com/plannaplan/models/package-info.java @@ -0,0 +1,6 @@ +/** + * Provides readonly (mostly) classes to keep data for diffrent pourposes + * + * @since 1.0 + */ +package com.plannaplan.models; diff --git a/buisnesslogic/src/main/java/com/plannaplan/repositories/AppConfigRepository.java b/buisnesslogic/src/main/java/com/plannaplan/repositories/AppConfigRepository.java index 08e3fbb..d0be800 100755 --- a/buisnesslogic/src/main/java/com/plannaplan/repositories/AppConfigRepository.java +++ b/buisnesslogic/src/main/java/com/plannaplan/repositories/AppConfigRepository.java @@ -4,5 +4,8 @@ import com.plannaplan.entities.AppConfig; import org.springframework.data.jpa.repository.JpaRepository; +/** + * Repository for app config + */ public interface AppConfigRepository extends JpaRepository { } diff --git a/buisnesslogic/src/main/java/com/plannaplan/repositories/package-info.java b/buisnesslogic/src/main/java/com/plannaplan/repositories/package-info.java new file mode 100755 index 0000000..4d5edc4 --- /dev/null +++ b/buisnesslogic/src/main/java/com/plannaplan/repositories/package-info.java @@ -0,0 +1,7 @@ +/** + * Provides jpa repositories interfaces to comunicate with database. These are + * used exclusively in services + * + * @since 1.0 + */ +package com.plannaplan.repositories; diff --git a/buisnesslogic/src/main/java/com/plannaplan/services/CourseService.java b/buisnesslogic/src/main/java/com/plannaplan/services/CourseService.java index 62356f6..efc8425 100755 --- a/buisnesslogic/src/main/java/com/plannaplan/services/CourseService.java +++ b/buisnesslogic/src/main/java/com/plannaplan/services/CourseService.java @@ -22,7 +22,7 @@ public class CourseService { /** * getCourseByName * - * @param name + * @param name name of course to be found * @return Course By Name */ public Optional getCourseByName(String name) { diff --git a/buisnesslogic/src/main/java/com/plannaplan/services/package-info.java b/buisnesslogic/src/main/java/com/plannaplan/services/package-info.java new file mode 100755 index 0000000..2870f10 --- /dev/null +++ b/buisnesslogic/src/main/java/com/plannaplan/services/package-info.java @@ -0,0 +1,7 @@ +/** + * Provides service classes to make operations with entities or comunicate with + * external systems. + * + * @since 1.0 + */ +package com.plannaplan.services; diff --git a/buisnesslogic/src/main/java/com/plannaplan/types/package-info.java b/buisnesslogic/src/main/java/com/plannaplan/types/package-info.java new file mode 100755 index 0000000..a68c251 --- /dev/null +++ b/buisnesslogic/src/main/java/com/plannaplan/types/package-info.java @@ -0,0 +1,6 @@ +/** + * Provides enums for different goals. + * + * @since 1.0 + */ +package com.plannaplan.types;