Skip to content

Commit d93bac0

Browse files
php-coderphp-coder
committed
Add javadoc to the top-level packages.
Addressed to #156 No code changes.
1 parent de815d5 commit d93bac0

20 files changed

+98
-0
lines changed

‎src/main/config/checkstyle-suppressions.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,7 @@
1717
<!-- false positives beause these files contain SQL queries -->
1818
<suppress checks="Translation" files="src/main/resources/sql" />
1919

20+
<!-- Too long link -->
21+
<suppress checks="LineLength" files="src/main/java/ru/mystamps/web/dao/impl/package-info.java" />
22+
2023
</suppressions>

‎src/main/java/ru/mystamps/web/config/package-info.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/**
2+
* Spring MVC application configuration.
3+
*/
4+
package ru.mystamps.web.config;

‎src/main/java/ru/mystamps/web/controller/converter/annotation/package-info.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/**
2+
* Annotations that are being used by converters to detect whether values
3+
* should be converted or not.
4+
*/
5+
package ru.mystamps.web.controller.converter.annotation;

‎src/main/java/ru/mystamps/web/controller/converter/package-info.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/**
2+
* Spring MVC converters for converting values from forms to the destination
3+
* types in the model objects.
4+
*/
5+
package ru.mystamps.web.controller.converter;

‎src/main/java/ru/mystamps/web/controller/editor/package-info.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/**
2+
* Property editors that are used for modifying values from forms.
3+
*/
4+
package ru.mystamps.web.controller.editor;

‎src/main/java/ru/mystamps/web/controller/package-info.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/**
2+
* Spring MVC controllers that handle users' requests to the application.
3+
*/
4+
package ru.mystamps.web.controller;

‎src/main/java/ru/mystamps/web/dao/dto/package-info.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/**
2+
* <a href="https://en.wikipedia.org/wiki/Data_access_object" target="_blank">DAO</a> layer:
3+
* <a href="https://en.wikipedia.org/wiki/Data_transfer_object" target="_blank">DTO</a>
4+
* classes that are being used by DAO as input/output values.
5+
*/
6+
package ru.mystamps.web.dao.dto;

‎src/main/java/ru/mystamps/web/dao/impl/package-info.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/**
2+
* <a href="https://en.wikipedia.org/wiki/Data_access_object" target="_blank">DAO</a> layer:
3+
* implementation of accessing data through JDBC.
4+
*
5+
* This implementation uses <a
6+
* href="https://docs.spring.io/spring/docs/4.3.x/spring-framework-reference/html/jdbc.html#jdbc-NamedParameterJdbcTemplate">NamedParameterJdbcTemplate</a>
7+
* from Spring Framework.
8+
*/
9+
package ru.mystamps.web.dao.impl;

‎src/main/java/ru/mystamps/web/dao/package-info.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/**
2+
* <a href="https://en.wikipedia.org/wiki/Data_access_object" target="_blank">DAO</a> layer:
3+
* interfaces for accessing data.
4+
*/
5+
package ru.mystamps.web.dao;

‎src/main/java/ru/mystamps/web/model/package-info.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/**
2+
* <a href="https://en.wikipedia.org/wiki/Data_transfer_object" target="_blank">DTO</a>
3+
* classes that are representing values from site forms and being used by
4+
* controllers as input values.
5+
*/
6+
package ru.mystamps.web.model;

‎src/main/java/ru/mystamps/web/package-info.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/**
2+
* Root package for the <a href="https://my-stamps.ru/" target="_blank">my-stamps.ru</a> web site.
3+
*/
4+
package ru.mystamps.web;

‎src/main/java/ru/mystamps/web/service/dto/package-info.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/**
2+
* Service layer: <a href="https://en.wikipedia.org/wiki/Data_transfer_object"
3+
* target="_blank">DTO</a> classes that are being used by service classes as
4+
* input/output values.
5+
*/
6+
package ru.mystamps.web.service.dto;

‎src/main/java/ru/mystamps/web/service/exception/package-info.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/**
2+
* Service layer: exceptions that may be thrown by the methods of the service classes.
3+
*/
4+
package ru.mystamps.web.service.exception;

‎src/main/java/ru/mystamps/web/service/package-info.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/**
2+
* Service layer: site <a href="https://en.wikipedia.org/wiki/Business_logic"
3+
* target="_blank">business logic</a>.
4+
*/
5+
package ru.mystamps.web.service;

‎src/main/java/ru/mystamps/web/support/spring/boot/package-info.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/**
2+
* Integration with <a href="https://projects.spring.io/spring-boot/"
3+
* target="_blank">Spring Boot</a>.
4+
*/
5+
package ru.mystamps.web.support.spring.boot;

‎src/main/java/ru/mystamps/web/support/spring/security/package-info.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/**
2+
* Integration with <a href="https://projects.spring.io/spring-security/"
3+
* target="_blank">Spring Security</a>.
4+
*/
5+
package ru.mystamps.web.support.spring.security;

‎src/main/java/ru/mystamps/web/support/togglz/package-info.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/**
2+
* Integration with <a href="https://www.togglz.org" target="_blank">Togglz</a>
3+
* (for using feature flags).
4+
*/
5+
package ru.mystamps.web.support.togglz;

‎src/main/java/ru/mystamps/web/util/package-info.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/**
2+
* Utility classes for the different tasks.
3+
*/
4+
package ru.mystamps.web.util;

‎src/main/java/ru/mystamps/web/validation/jsr303/package-info.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/**
2+
* Implementations of the custom <a href="http://beanvalidation.org/1.0/spec/"
3+
* target="_blank">JSR-303</a> compatible validators.
4+
*/
5+
package ru.mystamps.web.validation.jsr303;

‎src/main/java/ru/mystamps/web/validation/package-info.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/**
2+
* Classes and information for validating forms.
3+
*/
4+
package ru.mystamps.web.validation;

0 commit comments

Comments
 (0)