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

Assumir @type function como padrão #55

Open
izacsc opened this issue Jan 27, 2021 · 6 comments
Open

Assumir @type function como padrão #55

izacsc opened this issue Jan 27, 2021 · 6 comments
Labels
Doc HTML Controle das issues referente a documentação HTML enhancement New feature or request help wanted Extra attention is needed Snippets Issues relacionadas a snippets

Comments

@izacsc
Copy link

izacsc commented Jan 27, 2021

Caso não tenha sido definido, assumir @type function, por ser a maioria nos fontes.
Com isso diminui significantemente a quantidade de warnings emitidos.

@AlencarGabriel AlencarGabriel added enhancement New feature or request Snippets Issues relacionadas a snippets labels Jan 27, 2021
@AlencarGabriel
Copy link
Owner

Olá @izacsc , muito interessante tua solicitação.

Estarei verificando e implementando já para próxima versão.

@AlencarGabriel
Copy link
Owner

Olá @izacsc ,

estive analisando essa issue pra lançar já na proxima versão, e percebi que a extensão não deixa o atributo @type com "valor default". Ele detecta a assinatura da função, método ou classe e aplica o atributo conforme o tipo.

Portanto não faria sentido deixar function como default, se a geração da documentação já é dinâmica.

Poderia esclarecer melhor sua sugestão?

@AlencarGabriel AlencarGabriel added the Need more Information Precisa de mais informação label Mar 16, 2021
@izacsc
Copy link
Author

izacsc commented Mar 16, 2021 via email

@izacsc
Copy link
Author

izacsc commented Mar 25, 2021

@AlencarGabriel ficou claro? Preciso esclarecer mais algum ponto?

@AlencarGabriel
Copy link
Owner

Ficou claro sim, agora compreendi melhor.

Porém preciso avaliar melhor, pois o atributo @type é um dos obrigatórios, e eu trato ele em diversos pontos da extensão, pra fazer isso que sugeriu eu teria que alterar em todos esses pontos pra considerá-lo como: @type function default.

@AlencarGabriel AlencarGabriel added help wanted Extra attention is needed and removed Need more Information Precisa de mais informação labels Mar 25, 2021
@AlencarGabriel
Copy link
Owner

  • Tornar todos os atributos opcionais em seu conceito (visto haver uma grande variedades de uso do ProtheusDoc);
  • Criar uma configuração para definir quais atributos ProtheusDoc devem ter validação de omissão;
  • ...

@AlencarGabriel AlencarGabriel added the Doc HTML Controle das issues referente a documentação HTML label Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Doc HTML Controle das issues referente a documentação HTML enhancement New feature or request help wanted Extra attention is needed Snippets Issues relacionadas a snippets
Projects
None yet
Development

No branches or pull requests

2 participants