Parâmetro Opcional no ProtheusDoc
carloseniemeyer opened this issue · comments
Seria possível que essa engine do ProtheusDoc considerasse os parâmetros entre colchetes como parâmetros opcionais?
(https://tdn.totvs.com/display/tec/ProtheusDOC)
Exemplo:
@param nBase, numérico, Medida do lado ou da base
@param [nAltura], numérico, Medida da altura
@param [nBaseMenor], numérico, Medida da base menor (trapézios)
Os 2 últimos parâmetros são opcionais.
Hoje o diagnóstico está considerando como um erro no ProtheusDoc.
Seria muito interessante que isso fosse considerado tanto no diagnóstico, como na geração HTML (Informando o termo "Opcional" ao lado do parâmetro).
Isso evita termos que descrever na descrição do parâmetro se ele é opcional ou obrigatório.
Olá @carloseniemeyer ,
desde já obrigado por sua issue. Sua solicitação é bastante interessante, visto que na versão do antigo TDS Eclipse isso funcionava realmente:
Na época que desenhei essa extensão havia deixado de lado essa questão. Mas vou analisar sua solicitação e realizar os ajustes necessários.
Obrigado por informar, qualquer coisa relacionado a isso volto a falar por aqui.
Excelente notícia!
Olá @carloseniemeyer ,
venho informar que a implementação solicitada já foi desenvolvida, tanto aqui no lado da extensão, quando na dependência da documentação HTML (robsonrosilva/protheusDoc#4).
Resultado na extensão:
Agora não irá mais causar erros no diagnóstico quando o parâmetro for opcional, e no hover será informado.
Resultado no HTML:
Aguardando apenas a liberação do novo pacote da dependência, para lançamento da próxima versão aqui da extensão ProtheusDoc.