Difference between revisions of "Ja/Documentation/DevGuide/AppendixB/Special Markups"

Latest revision as of 14:36, 13 October 2009 (view source) G11nAutomation (Talk | contribs) (Created page with '{{Documentation/DevGuide/AppendixBTOC |ShowPrevNext=block |PrevPage=Documentation/DevGuide/AppendixB/Element Documentation |NextPage=Documentation/DevGuide/AppendixB/Special Docu…')

(No difference)

---

Latest revision as of 14:36, 13 October 2009

これらのマークアップタグは、ドキュメンテーションのレイアウトバージョン (HTML または XHTML) を生成する XSL プロセッサによって評価されます。これらのタグは、記述に間違いがなく、開始タグと終了タグがペアになっていて、大文字小文字も正しく記載されている必要があります。

クロスリファレンステーブルを構築したり、整合性をチェックする際に生成されたドキュメンテーションの識別子を強調し、ハイパーリンクを自動的に生成するには、すべての識別子をマークアップする必要があります。さらに、単独の語で構成されるメソッド名は動詞で区別できないので、校正にも重要になります。識別子は、編集者による再編集から除外する必要があります。

使用されるマークアップは以下のとおりです。

<atom>

このマークアップは、long、short、string などの atomar タイプの識別子で使用されます。タイプのシーケンスやアレイが参照される場合は、次元数を表すかっこのペア数とともに属性 dim を追加します。

これは下記のように利用します。

 <atom>long</atom>

シーケンスの例については、<type> を参照してください。

<type>

このマークアップは、インタフェース、サービス、typedef、struct、例外、enum、および定数グループの識別子に使用されます。タイプのシーケンスやアレイが参照される場合は、次元数を表すかっこのペア数とともに属性 dim を追加します。

これは下記のように利用します。

 type scope="com::sun::star::uno">XInterface</type>
 <type dim="[][]">PropertyValue</type>

<member>

このマークアップは、推奨されないメソッド、フィールド、および属性マークアップを置換し、struct と例外のフィールド、およびサービス仕様の属性やインターフェースのメソッドで使用されます。

これは下記のように利用します。

 <member scope="com::sun::star::uno">XInterface::queryInterface()</member>

<const>

このマークアップは、定数グループや enum の記号定数の識別子で使用されます。

これは下記のように利用します。

 <const scope="...">ParagraphAdjust::LEFT</const>

<TRUE/>, <FALSE/>

これらのマークアップは、Boolean 値 TRUE および FALSE の原子的な定数を表します。

これは下記のように利用します。

@returns

 数値が有効な場合は <TRUE\>、そうでない場合は <FALSE\>。

<NULL/>

このマークアップは、NULL 値の原子的な定数を表します。

<void/>

このマークアップは、原子的なタイプ void を表します。これは、<atom>void</atom> と同じです。

<code>

このマークアップは、インラインコードで使用されます。

これは下記のように利用します。

Use <code>queryInterface( NULL )</code> for:

 listing>
このマークアップは、複数行のコードの例で使用されます。
これは下記のように利用します。
@example StarBASIC
  <listing>
  aCmp = StarDesktop.loadComponentFromURL( ... )
if ( isnull(aCmp) )
  ....
endif
  </listing>