Class: JSDoc3

sdl.jsdoc. JSDoc3


new JSDoc3( [opt_path])

Classe responsável por exportar a documentação JSDoc de códigos-fontes JavaScript utilizando o JSDoc3.

Parameters:
Name Type Argument Description
opt_path string <optional>

Path onde se encontra o JSDoc. Caso não seja informado, será utilizada a instalação global do JSDoc.

Members


path :string

Caminho para o arquivo "jsdoc.cmd" da instalação do JSDoc a ser utilizada. O valor padrão utiliza o arquivo existente no path global.

Type:
  • string

pedantic :boolean

Define se warnings no JSDoc dos códigos-fontes serão tratados como erros durante a exportação.

Type:
  • boolean

<nullable> templatePath :string

Caminho onde se encontra o modelo visual no qual será gerada a documentação exportada. O valor padrão é null, indicado que o modelo padrão deverá ser utilizado.

Type:
  • string

Methods


extract(src, outDir)

Extrai o JSDoc dos códigos-fontes indicados em src. No diretório outDir será gravado a saída do JSDoc, normalmente um conjunto de páginas HTML com a documentação referencial.
A codificação esperada nos arquivos a terem o JSDoc extraído é a mesma da codificação do ambiente JavaScript, atualmente ISO-8859-1. Este método converterá automaticamente para a codificação UTF-8 esperada pelo JSDoc.

Parameters:
Name Type Description
src string

Arquivo ou diretório com os códigos-fontes que terão a documentação JSDoc exportada.

outDir string

Diretório onde será colocado o resultado do JSDoc.

Returns:

Objeto que possui a propriedade success para indicar se a execução foi bem sucedida ou não e a output com a saída gerada pelo JSDoc3.

Type
Object

getVersion()

Retorna a versão do JSDoc.

Returns:
Type
string

isAvailable()

Indica se o caminho #path aponta corretamente para uma instalação do JSDoc3.

Returns:
Type
boolean