JavaScript ドメイン

バージョン 1.0 で追加されました。

JavaScript ドメイン (名前 **js**) は、次のディレクティブを提供します。

.. js:module:: name

このディレクティブは、後続のオブジェクト宣言のモジュール名を設定します。モジュール名は、グローバルモジュールインデックスと相互参照で使用されます。このディレクティブは、例えば py:class のように、オブジェクトの見出しを作成しません。

デフォルトでは、このディレクティブはリンク可能なエンティティを作成し、no-index オプションが指定されていない限り、グローバルモジュールインデックスのエントリを作成します。このオプションが指定されている場合、ディレクティブは現在のモジュール名のみを更新します。

バージョン 1.6 で追加されました。

バージョン 5.2 で変更されました: モジュールディレクティブは本文コンテンツをサポートします。

.. js:function:: name(signature)

JavaScript 関数またはメソッドについて説明します。引数をオプションとして記述する場合は、Python シグネチャについて説明されているように、角括弧を使用します。documented

フィールドを使用して、引数とその期待される型、関数によってスローされる可能性のあるエラー、および返される値に関する詳細情報を提供できます。

.. 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.

これは次のようにレンダリングされます。

$.getJSON(href, callback[, errback])
引数：

  • href (string()) – リソースの場所へのURI。

  • callback – オブジェクトで呼び出されます。

  • errback – リクエストが失敗した場合に呼び出されます。そして、多くの他のテキストがあるので、複数行が必要です。

スロー：

SomeError() – その場合の理由。

戻り値：

何か。

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

javascript_maximum_signature_line_length と maximum_signature_line_length を上書きし、関数の引数を単一の論理行に出力するようにします。

バージョン 7.1 で追加されました。

.. js:method:: name(signature)

このディレクティブは js:function のエイリアスですが、クラスオブジェクトのメソッドとして実装されている関数を記述します。

バージョン 1.6 で追加されました。

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

javascript_maximum_signature_line_length と maximum_signature_line_length を上書きし、関数の引数を単一の論理行に出力するようにします。

バージョン 7.1 で追加されました。

.. js:class:: name

オブジェクトを作成するコンストラクタについて説明します。これは基本的に関数と同じですが、「class」プレフィックス付きで表示されます。

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

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

これは次のようにレンダリングされます。

class MyAnimal(name[, age])
引数：

  • name (string()) – 動物の名前

  • age (number()) – 動物のオプションの年齢

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

javascript_maximum_signature_line_length と maximum_signature_line_length を上書きし、関数の引数を単一の論理行に出力するようにします。

バージョン 7.1 で追加されました。

.. js:data:: name

グローバル変数または定数について説明します。

.. js:attribute:: object.name

オブジェクトの属性 *name* について説明します。

これらのロールは、記述されたオブジェクトを参照するために提供されます。

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