Skip to content

Commit

Permalink
feat/i11 📝 Atualizar javadoc de classes variadas para "@"since
Browse files Browse the repository at this point in the history
As marcações de versão nos javadocs de várias classes foram alteradas de "@"version para "@"since. Essa alteração reflete mais precisamente o propósito do javadoc, que é indicar desde qual versão a classe ou método está disponível, e não necessariamente a sua versão atual.
  • Loading branch information
diegosneves committed Jun 17, 2024
1 parent 389a611 commit 03c8a91
Show file tree
Hide file tree
Showing 30 changed files with 30 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
* </pre>
*
* @author diegosneves
* @since 1.0.0
*/
@Configuration
public class CorsConfig {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
* <p>
*
* @author diegosneves
* @since 1.0.0
*/
@Configuration
public class OpenApiConfig {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
* A classe {@link WebSecurityConfig} tem a responsabilidade de definir as configurações de segurança web desta aplicação.
*
* @author diegosneves
* @since 1.0.0
*/
@Configuration
@EnableWebSecurity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* Uma instância desta classe representa um abrigo com uma identificação, um nome de referência, um endereço, um usuário responsável, e uma lista de doações.
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
* @see ShelterContract
*/
public class Shelter implements ShelterContract {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* além da adição de doações e recuperação de um usuário responsável pelo abrigo.
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
*/
public interface ShelterContract {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* Este classe é utilizada na criação de entidades tais como {@link Shelter}, que precisam de uma representação de endereço.
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
*/
@Getter
public class Address {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* Uma doação é caracterizada pela sua descrição e quantidade.
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
*/
@Getter
public class Donation {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* Esta classe destaca a declaração de um método público estático create, responsável pela criação de uma instance de {@link Shelter}.
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
* @see Shelter
*/
public class ShelterFactory {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* <p>
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
* @see RepositoryContract
* @see Shelter
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* </p>
*
* @author diegoneves
* @version 1.0
* @since 1.0.0
*/
public class User implements UserContract {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* {@link UserCreationFailureException}.
*
* @author diegoneves
* @version 1.0
* @since 1.0.0
* @see UserCreationFailureException
* @see RuntimeException
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* Os perfis disponíveis são {@code 'Doador'} e {@code 'Beneficiário'}.
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
*/
public enum UserProfile {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
* </p>
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
* @see User
*/
public class UserFactory {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* <p> Caso as operações de pesquisa não possam encontrar usuário(s) correspondente, eles retornarão um valor nulo ou uma lista vazia.
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
* @see RepositoryContract
* @see UserContract
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* </p>
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
*/
public enum ExceptionDetails {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
* <p>
* @author diegosneves
* @see RuntimeException
* @version 1.0
* @since 1.0.0
*/
public class AddressCreationFailureException extends RuntimeException {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* String para o construtor ao instanciar um novo objeto {@link DonationRegisterFailureException}.
* </p>
* @author diegoneves
* @version 1.0
* @since 1.0.0
* @see RuntimeException
*/
public class DonationRegisterFailureException extends RuntimeException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
* <p>
* @author diegosneves
* @see RuntimeException
* @version 1.0
* @since 1.0.0
*/
public class ShelterCreationFailureException extends RuntimeException {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
* <p>
* @author diegosneves
* @see RuntimeException
* @version 1.0
* @since 1.0.0
*/
public class ShelterServiceFailureException extends RuntimeException {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
* </pre>
* <p>
* @author diegosneves
* @version 1.0
* @since 1.0.0
*/
public class UserCreationFailureException extends RuntimeException {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
* </pre>
* <p>
* @author diegosneves
* @version 1.0
* @since 1.0.0
* @see RuntimeException
*/
public class UserServiceFailureException extends RuntimeException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*
* @author diegoneves
* @see RuntimeException
* @version 1.0.0
* @since 1.0.0
*/
public class UuidUtilsException extends RuntimeException {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*
* @author diegoneves
* @see RuntimeException
* @version 1.0.0
* @since 1.0.0
*/
public class ValidationUtilsException extends RuntimeException {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
*
* @param <T> o tipo de entidade com a qual essa interface de repositório trabalha.
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
*/
public interface RepositoryContract<T> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
* Esta classe implementa a interface {@link ShelterServiceContract}.
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
* @see ShelterServiceContract
* @see ShelterRepository
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* Isso inclui criar um abrigo, alterar o nome e o endereço de um abrigo, adicionar uma doação e obter detalhes de um abrigo.
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
*/
public interface ShelterServiceContract {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
* eles lançarão uma exceção {@link UserServiceFailureException}.
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
* @see UserServiceContract
* @see UserRepository
* @see UserServiceFailureException
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* Interface para o contrato de serviço do usuário. Define os métodos funcionais para todos os serviços de usuário.
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
*/
public interface UserServiceContract {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* Esta classe fornece métodos estáticos para gerar um novo {@link UUID} e para validar um {@link UUID} existente.
*
* @author diegoneves
* @since 1.0.0
*/
@Slf4j
public class UuidUtils {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* Contém todos os métodos estáticos e não pode ser instanciada.
*
* @author diegoneves
* @version 1.0.0
* @since 1.0.0
*/
public class ValidationUtils {

Expand Down

0 comments on commit 03c8a91

Please sign in to comment.