O domínio JavaScript

Adicionado na versão 1.0.

O domínio JavaScript (nome js) fornece as seguintes diretivas:

.. js:module:: name

Esta diretiva define o nome do módulo para declarações de objetos a seguir. O nome do módulo é usado no índice global de módulos e em referências cruzadas. Esta diretiva não cria um cabeçalho de objeto como py:class faria, por exemplo.

Por padrão, esta diretiva criará uma entidade vinculável e causará uma entrada no índice global de módulos, a menos que a opção no-index seja especificada. Se esta opção for especificada, a diretiva atualizará apenas o nome do módulo atual.

Adicionado na versão 1.6.

Alterado na versão 5.2: Diretivas de módulo possuem suporte a conteúdo do corpo.

.. js:function:: name(signature)

Descreve uma função ou método JavaScript. Se você quiser descrever argumentos como opcionais, use colchetes como documentado para assinaturas Python.

Você pode usar campos para fornecer mais detalhes sobre argumentos e seus tipos esperados, erros que podem ser lançados pela função e o valor retornado:

.. js:function:: $.getJSON(href, callback[, errback])

   :param string href: An URI to the location of the resource.
   :param callback: Gets called with the object.
   :param errback:
       Gets called in case the request fails. And a lot of other
       text so we need multiple lines.
   :throws SomeError: For whatever reason in that case.
   :returns: Something.

Isso é renderizado como:

$.getJSON(href, callback[, errback])
Argumentos:

  • href (string) – An URI to the location of the resource.

  • callback – Gets called with the object.

  • errback – Gets called in case the request fails. And a lot of other text so we need multiple lines.

Lança:

SomeError – For whatever reason in that case.

Retorna:

Something.

:single-line-parameter-list: (no value)

Garante que os parâmetros da função serão emitidos em uma única linha lógica, substituindo javascript_maximum_signature_line_length e maximum_signature_line_length.

Adicionado na versão 7.1.

.. js:method:: name(signature)

Esta diretiva é um apelido para js:function, porém descreve uma função que é implementada como um método em um objeto de classe.

Adicionado na versão 1.6.

:single-line-parameter-list: (no value)

Garante que os parâmetros da função serão emitidos em uma única linha lógica, substituindo javascript_maximum_signature_line_length e maximum_signature_line_length.

Adicionado na versão 7.1.

.. js:class:: name

Descreve um construtor que cria um objeto. Isto é basicamente como uma função, mas aparecerá com um prefixo class:

.. js:class:: MyAnimal(name[, age])

   :param string name: The name of the animal
   :param number age: an optional age for the animal

Isso é renderizado como:

class MyAnimal(name[, age])
Argumentos:

  • name (string) – The name of the animal

  • age (number) – an optional age for the animal

:single-line-parameter-list: (no value)

Garante que os parâmetros da função serão emitidos em uma única linha lógica, substituindo javascript_maximum_signature_line_length e maximum_signature_line_length.

Adicionado na versão 7.1.

.. js:data:: name

Descreve uma variável ou constante global.

.. js:attribute:: object.name

Descreve o atributo name de object.

Essas funções são fornecidas para fazer referência aos objetos descritos:

:js:mod:
:js:func:
:js:meth:
:js:class:
:js:data:
:js:attr: