Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc/issues-19(Adicionar Javadoc ao Projeto) 📝 #22

Merged
merged 3 commits into from
Mar 10, 2024
Merged

Conversation

diegosneves
Copy link
Owner

@diegosneves diegosneves commented Mar 10, 2024

Solicitação de Pull Request

Status

  • In Progress
  • Ready to Merging

Tipo

  • Release
  • Feature
  • Technical Debt
  • Fix
  • Test
  • Refactor
  • Documentation
  • Performance

Descrição

doc/issues-19(Adicionar Javadoc ao Projeto) 📝 Adicionar comentários Javadoc abrangentes em todo o package cli

  • Adicionar comentários Javadoc abrangentes em todo o projeto

    Melhorou a legibilidade e forneceu explicações detalhadas sobre classes, seus métodos e funcionalidades através da adição de comentários Javadoc completos.

  • Comentários que tocam múltiplas partes do código

    O diff toca várias partes do código, como a interface do controle CLI, implementação de serviço, repositório e classes de entidade, entre outros. Isso proporciona uma compreensão aprofundada de seu propósito e interação dentro do projeto.


doc/issues-19(Adicionar Javadoc ao Projeto) 📝 Atualização da Documentação e Melhoria na Legibilidade do Projeto

  • Comentários Javadoc Abrangentes Adicionados: Foram incluídos comentários Javadoc completos nas classes e métodos do projeto no pacote 'rest'.

    • Interface do controlador CLI: Comentários explicativos adicionados para melhorar a compreensão da funcionalidade da interface.

    • Implementação do serviço: Adicionado comentários detalhados para explicar os serviços implementados.

    • Repositório: Inclusão de comentários para auxiliar no entendimento de como o repositório é utilizado.

    • Classes de Entidades: Adicionados comentários para explicar a funcionalidade e propósito de cada entidade.

  • Melhoria na Legibilidade: Esta atualização melhora a legibilidade do projeto e fornece explicações detalhadas sobre as classes e suas funcionalidades.


doc/issues-19(Adicionar Javadoc ao Projeto) 📝 Adicionar comentários Javadoc abrangentes aos mapeadores

  • Adicionar comentários Javadoc abrangentes aos mapeadores

    Adicionados comentários Javadoc abrangentes a todas as classes e seus métodos dentro do pacote 'mapper' para melhorar a clareza e compreensão de suas funcionalidades.

  • Aumentar a legibilidade

    Isso aumenta a legibilidade e fornece explicações detalhadas sobre os papéis, alcance e responsabilidades de cada classe.

  • Transformando e mapeando objetos de Produto

    Explica como eles transformam e mapeiam objetos de Produto.

…avadoc abrangentes em todo o package `cli`

- **Adicionar comentários Javadoc abrangentes em todo o projeto**

   Melhorou a legibilidade e forneceu explicações detalhadas sobre classes, seus métodos e funcionalidades através da adição de comentários Javadoc completos.

- **Comentários que tocam múltiplas partes do código**

   O diff toca várias partes do código, como a interface do controle CLI, implementação de serviço, repositório e classes de entidade, entre outros. Isso proporciona uma compreensão aprofundada de seu propósito e interação dentro do projeto.
@diegosneves diegosneves added the documentation Improvements or additions to documentation label Mar 10, 2024
@diegosneves diegosneves self-assigned this Mar 10, 2024
@diegosneves diegosneves linked an issue Mar 10, 2024 that may be closed by this pull request
3 tasks
…ação e Melhoria na Legibilidade do Projeto

- **Comentários Javadoc Abrangentes Adicionados**: Foram incluídos comentários Javadoc completos nas classes e métodos do projeto no pacote 'rest'.

    - *Interface do controlador CLI:* Comentários explicativos adicionados para melhorar a compreensão da funcionalidade da interface.

    - *Implementação do serviço:* Adicionado comentários detalhados para explicar os serviços implementados.

    - *Repositório:* Inclusão de comentários para auxiliar no entendimento de como o repositório é utilizado.

    - *Classes de Entidades:* Adicionados comentários para explicar a funcionalidade e propósito de cada entidade.

- **Melhoria na Legibilidade:** Esta atualização melhora a legibilidade do projeto e fornece explicações detalhadas sobre as classes e suas funcionalidades.
…avadoc abrangentes aos mapeadores

- **Adicionar comentários Javadoc abrangentes aos mapeadores**

    Adicionados comentários Javadoc abrangentes a todas as classes e seus métodos dentro do pacote 'mapper' para melhorar a clareza e compreensão de suas funcionalidades.

- **Aumentar a legibilidade**

    Isso aumenta a legibilidade e fornece explicações detalhadas sobre os papéis, alcance e responsabilidades de cada classe.

- **Transformando e mapeando objetos de Produto**

    Explica como eles transformam e mapeiam objetos de Produto.
@diegosneves diegosneves merged commit 0160c71 into develop Mar 10, 2024
1 check passed
@diegosneves diegosneves deleted the doc/issues-19 branch March 10, 2024 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adicionar Javadoc ao Projeto 📝
1 participant