ドキュメンテーションシステム Sphinx構文¶

Fabric Engine version 2.4.0

kl_example_directive: klサンプルをsphinxから直接実行します
kl_fileexample_directive: sphinxから直接実行できるファイルベースのklサンプル
kl_css_directive: ネスト可能なcss構文、自動生成される refs 内で sphinxの見た目を微調整
kl_constant_directive: KL定数の文書生成
kl_function_directive: KL関数の自由記述文書生成
kl_interface_directive: KLインタフェースの文書生成
kl_inheritance_directive: KL継承ダイアグラム文書生成
kl_type_directive: KLの型 (struct, object)文書生成
kl_method_directive: KLメソッド（一個）文書生成
kl_methodlist_directive: 全KLメソッド (あるタイプもしくはカテゴリに属するもの)の一覧文書生成
kl_ext_constantlist_directive: あるエクステンション中の定数一覧文書生成
kl_ext_interfacelist_directive: あるエクステンションの全インタフェースの目次（TOC）文書生成
kl_ext_typelist_directive: あるエクステンションの全型の目次（TOC）文書生成
kl_ext_functionlist_directive: あるエクステンション中の全関数文書生成

kl-example 構文¶

kl-example 構文はページにKLコード（の断片）の埋め込みに使います。一部とはいえコードは実際に呼びだされ出力を収集します。”nooutput” オプションにより出力を抑制することもできます。

.. kl-example:: Math-Test

  require Math;

  operator entry() {
    Vec3 a(1,2,3);
    Vec3 b(4,5,6);
    report(a + b);
  }

kl-fileexample 構文¶

kl-fileexample は kl-example 構文と同じですが、入力にファイルパスを使用します。${ENVVAR} 記法により環境変数を埋めることもできます。

.. kl-fileexample:: ${FABRIC_SCENE_GRAPH_DIR}/Tests/Singletons/Singletons_Test1.kl

kl-css 構文¶

kl-css 構文は、ある段落へ <異なる css classを持つブロック> を埋め込むことができます。実装するcssは _static/custom.css です。この構文に使用でき必要な引数は、適用するクラスメイトの名前です。 kl-css 構文は kl-ref 構文によって、コンテンツ内の全ての型に対して同時に自動生成されます。これにより KL型はクリック可能になります。

.. kl-css:: plaintext

  In this example we are mentioning a Vec3 as well as a Mat44.

kl-constant 構文¶

kl-constant 構文は、KL定数ドキュメント生成に使用します。

title: (0(ディフォルト) to 7): タイトルレベルを定義 (0 == オフ, 1 ファーストレベルタイトル)
createrefs: (0(ディフォルト) or 1): この定数への sphinx レファレンスを作成。エクステンションのメインページ内でのみ機能します。
userefs: (0 or 1(ディフォルト)): 無効／有効既知の KL型への参照（Refs）の自動生成切り替え
brief: (0 or 1(ディフォルト)): 要素の概要を含めるか
plaintext: (0 or 1(ディフォルト)): 要素のプレインテキストな説明を含めるか
customrst: (0 or 1(ディフォルト)): カスタムrst を含めるか (rst, endrst により定義)
example: (0 or 1(ディフォルト)): KLでの使用例を含めるか (example, endexample により定義)

.. kl-constant:: MAX_NAME_LENGTH
  title=0;
  createrefs=1;

kl-function 構文¶

kl-function 構文は KL関数のドキュメント生成に使用します。

title: (0(ディフォルト) to 7): タイトルレベルを定義 (0 == オフ, 1 ファーストレベルタイトル)
createrefs: (0(ディフォルト) or 1): この関数へのsphinx レファレンスを作成。エクステンションのメインページ内でのみ機能します。
userefs: (0 or 1(ディフォルト)): 無効／有効既知の KL型への参照（Refs）の自動生成切り替え
params: (0(ディフォルト) or 1): 関数の全パラメータをドキュメントに含めるか
brief: (0 or 1(ディフォルト)): 要素の概要を含めるか
plaintext: (0 or 1(ディフォルト)): 要素のプレインテキストな説明を含めるか
customrst: (0 or 1(ディフォルト)): カスタムrst を含めるか (rst, endrst により定義)
example: (0 or 1(ディフォルト)): KLでの使用例を含めるか (example, endexample により定義)

.. kl-function:: radToDeg
  params=1;
  createrefs=1;

kl-interface 構文¶

kl-interface 構文は KLインタフェースのドキュメント生成に使用します。

title: (0(ディフォルト) to 7): タイトルレベルを定義 (0 == オフ, 1 ファーストレベルタイトル)
createrefs: (0(ディフォルト) or 1): この関数へのsphinx レファレンスを作成。エクステンションのメインページ内でのみ機能します。
userefs: (0 or 1(ディフォルト)): 無効／有効既知の KL型への参照（Refs）の自動生成切り替え
methods: (0 or 1(ディフォルト)): インタフェースの全メソッドをドキュメントに含める
brief: (0 or 1(ディフォルト)): 要素の概要を含めるか
plaintext: (0 or 1(ディフォルト)): 要素のプレインテキストな説明を含めるか
customrst: (0 or 1(ディフォルト)): カスタムrst を含めるか (rst, endrst により定義)
example: (0 or 1(ディフォルト)): KLでの使用例を含めるか (example, endexample により定義)

.. kl-interface:: MyInterface
  methods=1;
  createrefs=0;

kl-inheritance 構文¶

kl-inheritance 構文は継承グラフの生成に使用します。

.. kl-inheritance:: MySpecializedObject

kl-method 構文¶

kl-method 構文は KLメソッドのドキュメント生成に使用します。

title: (0(ディフォルト) to 7): タイトルレベルを定義 (0 == オフ, 1 ファーストレベルタイトル)
createrefs: (0(ディフォルト) or 1): この関数へのsphinx レファレンスを作成。エクステンションのメインページ内でのみ機能します。
userefs: (0 or 1(ディフォルト)): 無効／有効既知の KL型への参照（Refs）の自動生成切り替え
params: (0(ディフォルト) or 1): メソッドの全パラメータをドキュメントに含める
brief: (0 or 1(ディフォルト)): 要素の概要を含めるか
plaintext: (0 or 1(ディフォルト)): 要素のプレインテキストな説明を含めるか
customrst: (0 or 1(ディフォルト)): カスタムrst を含めるか (rst, endrst により定義)
example: (0 or 1(ディフォルト)): KLでの使用例を含めるか (example, endexample により定義)

.. kl-method:: MyObject.getS

kl-methodlist 構文¶

kl-methodlist 構文は、KLメソッドのリストのドキュメント生成に使用します。

title: (0(ディフォルト) to 7): タイトルレベルを定義 (0 == オフ, 1 ファーストレベルタイトル)
createrefs: (0(ディフォルト) or 1): それぞれのメソッドへのsphinx レファレンスを作成。エクステンションのメインページ内でのみ機能します。
userefs: (0 or 1(ディフォルト)): 無効／有効既知の KL型への参照（Refs）の自動生成切り替え
compact: (0(ディフォルト) or 1): 用例などを省略し、コンパクトなメソッドリストにする
includeinherited: (0 or 1(ディフォルト)): 有効の場合、継承されたメソッドも表示する
includeprivate: (0(ディフォルト) or 1): 有効の場合、privateメソッドも表示する
category: (String): メソッドのカテゴリのリスト (オペレータであれば “オペレータ”, 基本的には空文字列)
brief: (0 or 1(ディフォルト)): 各メソッドの概要を含める
plaintext: (0 or 1(ディフォルト)): 各メソッドのプレインテキストな説明を含める
customrst: (0 or 1(ディフォルト)): 各メソッドのカスタム rst (rst, endrst により定義)を含める
example: (0 or 1(ディフォルト)): 各メソッドのKLでの使用例を含めるか (example, endexample により定義)

.. kl-methodlist:: MyStruct
  category=operators;
  example=0;
  brief=0;
  plaintext=1;

Vec4 メソッド（複数）をコンパクトリスト:

.. kl-methodlist:: Vec4
  compact=1;

kl-type 構文¶

kl-type 構文は、KL型（構造体, オブジェクト）のドキュメント生成に使用します

title: (0(ディフォルト) to 7): タイトルレベルを定義 (0 == オフ, 1 ファーストレベルタイトル)
createrefs: (0(ディフォルト) or 1): この型へのsphinx レファレンスを作成。エクステンションのメインページ内でのみ機能します。
userefs: (0 or 1(ディフォルト)): 無効／有効既知の KL型への参照（Refs）の自動生成切り替え
inheritancegraph: (0 or 1(ディフォルト)): 継承グラフを表示
members: (0 or 1(ディフォルト)): データタイプのメンバを含める
methods: (0 or 1(ディフォルト)): インタフェースの全メソッドをドキュメントに含める
brief: (0 or 1(ディフォルト)): 要素の概要を含めるか
plaintext: (0 or 1(ディフォルト)): 要素のプレインテキストな説明を含めるか
customrst: (0 or 1(ディフォルト)): カスタムrst を含めるか (rst, endrst により定義)
example: (0 or 1(ディフォルト)): KLでの使用例を含めるか (example, endexample により定義)

.. kl-type:: Bone
  members=1;
  methods=0;
  createrefs=0;

kl-ext-constantlist 構文¶

kl-ext-constantlist 構文はあるエクステンション中の全定数のリストに使用します

title: (0(ディフォルト) to 7): タイトルレベルを定義 (0 == オフ, 1 ファーストレベルタイトル)
includeprivate: (0(ディフォルト) or 1): 有効の場合、privateインタフェースも表示する
createrefs: (0(ディフォルト) or 1): それぞれの定数へのsphinx レファレンスを作成。エクステンションのメインページ内でのみ機能します。
userefs: (0 or 1(ディフォルト)): 無効／有効既知の KL型への参照（Refs）の自動生成切り替え
brief: (0 or 1(ディフォルト)): 要素の概要を含めるか
plaintext: (0 or 1(ディフォルト)): 要素のプレインテキストな説明を含めるか
customrst: (0 or 1(ディフォルト)): カスタムrst を含めるか (rst, endrst により定義)
example: (0 or 1(ディフォルト)): KLでの使用例を含めるか (example, endexample により定義)

.. kl-ext-constantlist:: Alembic
  includeprivate=1;

kl-ext-interfacelist 構文¶

kl-ext-interfacelist 構文は、あるエクステンション中の全インタフェースの目次ツリーリストに使用します。

title: (0(ディフォルト) to 7): タイトルレベルを定義 (0 == オフ, 1 ファーストレベルタイトル)
includeprivate: (0(ディフォルト) or 1): 有効の場合、privateインタフェースも表示する

.. kl-ext-interfacelist:: Geometry
  includeprivate=1;

kl-ext-typelist 構文¶

kl-ext-typelist 構文は、あるエクステンション中の全”型”の目次ツリーリストに使用します。（正しいラベルとレファレンスを持つものだけを表示します。全てを実装しているわけではありません）

title: (0(ディフォルト) to 7): タイトルレベルを定義 (0 == オフ, 1 ファーストレベルタイトル)
includeprivate: (0(ディフォルト) or 1): 有効の場合、privateインタフェースも表示する
compact: (0(ディフォルト) or 1): 用例などを省略し、コンパクトな関数のリストにする
createrefs: (0(ディフォルト) or 1): それぞれの関数へのsphinx レファレンスを作成。エクステンションのメインページ内でのみ機能します。

.. kl-ext-typelist:: Math

kl-ext-functionlist 構文¶

kl-ext-functionlist 構文は、kl-methodlist とほぼ同じですが、関数についてのリストを生成に使用します。

title: (0(ディフォルト) to 7): タイトルレベルを定義 (0 == オフ, 1 ファーストレベルタイトル)
includeprivate: (0(ディフォルト) or 1): 有効の場合、privateインタフェースも表示する
compact: (0(ディフォルト) or 1): 用例などを省略し、コンパクトな関数のリストにする
createrefs: (0(ディフォルト) or 1): それぞれの関数へのsphinx レファレンスを作成。エクステンションのメインページ内でのみ機能します。
category: (String): 関数のカテゴリのリスト (基本的に空文字列)
userefs: (0 or 1(ディフォルト)): 無効／有効既知の KL型への参照（Refs）の自動生成切り替え
brief: (0 or 1(ディフォルト)): 各関数の概要を含める
plaintext: (0 or 1(ディフォルト)): 各関数のプレインテキストな説明を含める
customrst: (0 or 1(ディフォルト)): 各関数のカスタム rst (rst, endrst により定義)を含める
example: (0 or 1(ディフォルト)): 各関数のKLでの使用例を含めるか (example, endexample により定義)

.. kl-ext-functionlist:: Math
  compact=1;

.. kl-ext-functionlist:: FabricTEEM
  compact=0;