Namespace: jsdoc

sdl. jsdoc

Namespace da biblioteca de funções referentes ao processamento de código com a API do JSDoc.
Para utilizar está API é necessária inclui-la conforme o exemplo abaixo.

Example

__includeOnce('ufs:sdl/jsdoc/jsdoc.js');

Classes

JSDoc3

Methods


<static> getFileSource(fileId)

Obtém o conteúdo do arquivo informado que deve ser exportado pela ferramenta do JSDoc.

Parameters:
Name Type Description
fileId string | number

Chave de um arquivo na VFS ou o caminho do arquivo na UFS.

Returns:

Conteúdo do arquivo preparado para ser processado pela ferramenta de JSDoc.

Type
String

<static> getFilesToPublish()

Obtém a relação dos arquivos que devem ter a documentação JSDoc publicada.

Returns:

Retorna um array contendo as informações sobre os arquivos a terem a sua documentação publicada. Cada elemento terá as seguintes propriedades:

  • system: indica se o arquivo está armazenado na 'vfs' ou 'ufs';
  • name: nome do arquivo.
  • path: caminho completo do arquivo.
  • id: identificado único do arquivo. Será a chave para arquivos da VFS e o caminho para arquivos da UFS.
    *
  • key: chave do arquivo. Para arquivos armazenados na UFS, será nulo.
Type
Array.<{system: string, name: string, key: ?number, id: (number|string), path: string}>

<static> prepareSource()

Prepara o fonte para ser interpretado pelo JSDoc. Hoje temos um comentário especial que injeta códigos JavaScript que devem ser interpretados apenas pelo JSDoc. Esses comentários seguem a estrutura abaixo: /*jsdoc Source to JSDoc. jsdoc*/.
Esta função também transforma as strings em múltiplas linhas suportadas pelo Engine em strings simples, pois elas não são suportados por algumas versões do JSDoc.

Returns:

Código fonte que deve ser interpretado pelo JSDoc.

Type
string