Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Abra o arquivo HTML em seu navegador preferido para ler a documentação customizada que foi gerada.

Marcações aceitas

As marcações aceitas pelo ProtheusDOC até o momento são:

MarcaçãoParâmetrosDescrição da marcação

@accessLevel

 Nível de acesso.
@authorname-text

Texto com o nome do autor.

@build Indica qual a versão do servidor requerido (similar a "@version").
@country Indica para qual país o elemento foi programado.
@database Compatibilidade com base de dados.
@description Cria uma entrada de descrição, para melhor detalhamento da funcionalidade.
@deprecated

deprecated-text

Texto com comentários sobre a depreciação, como por exemplo, motivo e alternativa que deve ser utilizada.

@example Cria uma entrada no tópico “Exemplos”.
@sample O mesmo que "@example". 
@language Idioma para o qual elemento está customizado.
@link Cria uma ligação (link) para o target especificado (ver notas). O atributo label será apresentado ao desenvolvedor no lugar da URI e é opcional. Esta marcação deve ser utilizada como complemento nas demais marcações.
@obs Adiciona uma observação.
@paramparameter-name parameter-type descriptionAdiciona uma especificação de parâmetro (de função ou método), identificando-o como parameter-name. 
@protected Indica que o método deve ser visto com escopo de “não publico”.
@returnreturn-type descriptionEspecifica o retorno (de função ou método).
@systemOper Indica qual o Sistema Operacional requerido.
@seesee-textAdiciona uma entrada “Veja também”.
@since Identifica a partir de quando, uma determinada funcionalidade foi implementada.
@todo Identifica uma tarefa a ser realizada.
@version Indica para qual versão de produto ou mesmo servidor, que uma determinada funcionalidade requer.