コマンドや関数のパラメーターを書く <properties>

リファレンス・トピックのコマンドや関数のパラメーター(properties要素)には、コマンドのオプションや関数の引数などの説明を表形式で記述します。

properties要素では、パラメーターごとに型(proptype要素)、値(propvalue要素)、および説明(propdesc要素)を記述します。1行(property要素)につき、1つのパラメーターを記述します。

properties要素は、リファレンス・トピックの本文(refbody要素)の直下にだけ配置できます。properties要素は単純な表の構造しか表せないため、コマンドや関数のパラメーターの前にタイトルを書くときは工夫が必要です。コマンドや関数のパラメーターの前にタイトルを書くには、properties要素の前に、タイトル(title要素)だけを書いたセクション(section要素)を配置します。

パラメーターの記述例

<refbody>
  <refsyn>
    :
  </refsyn>
  <properties>
    <prophead>
      <proptypehd>引数型</proptypehd>
      <propvaluehd>値</propvaluehd>
      <propdeschd>解説</propdeschd>
    </prophead>
    <property>
      <proptype>int</proptype>
      <propvalue>0</propvalue>
      <propdesc>正常終了</propdesc>
    </property>
    <property>
      <propvalue>-1</propvalue>
      <propdesc>エラー発生</propdesc>
    </property>
  </properties>
    :
</refbody>