• Showing Page History #25610
  • Showing Page History #20293

Show page source of YukiDoc #32027

>[Yuki]

== YukiDoc ==

Yukiのそれぞれのプラグインに含まれるクラス、及びそのメソッドの仕様のドキュメント。

このドキュメントは定められた仕様のXML形式にて作成する。[[BR]]
XML形式であるため、例えばHTMLの状態で見たいのであればXSLTを用いて変換すれば良いし、
そのHTMLの形式を変える事も容易になる。

YukiではこのYukiDoc XMLを読み込み、使えるクラス、メソッドを一覧表示したり、パラメータヒントを出したりする。

 * [YukiDocXML/仕様]
 * [YukiDoc/内部設計資料]
 * [YukiDoc/詳細]
 * [YukiDoc/Doxygen連携]

=== ソース上コメントからの生成 ===

JavaDoc等のように、ソース上コメントからYukiDocXMLを生成出来たら便利だと思う。誰かやって!

=== 応用 ===

別にYukiのプラグインに限らず、普通のC++、Java等のドキュメントとしても
このYukiDoc XMLを利用すれば、XSLTを用いて幾らでも表現形態を変えられるので便利なのでは?と思う。
XSLTに限らず、プログラム上から何らかの利用を行いたい場合にも、XML形式であるため便利だしね。