ドキュメンテーションツール [sf#8]

[k-okada]

This post was originally posted at http://sourceforge.net/p/jskeus/tickets/8

doctoolsでスロット変数のdocumentation部分を表示するようにして， かつrstで出して，pdf/htmlに変換する，という流れがいいと思います．
doctools

euslib/llib/doctools.l
を直しました。

irteusgl doctools.l
(html-jsk-classes)
として、
gnome-open index.html
とすると、irteusgl で定義されているクラス、(jsk)で定義されているクラス、(rbrain)で
定義されているクラスの３つのリンクを含んだindex.htmlページが表示されます。

$ irteusgl (html-doc-classes "index.html" (jsk-libraries) (rbrain-libraries))

と同じものです。
$ (html-doc-classes "aaa.html" (test1) (test2) ... (testn))
は、(test1) ... (testn)のそれぞれで追加で定義されるクラスの差分の
ドキュメントファイルを生成し、それぞれのファイルへのリンクを含んだ
aaa.htmlファイルを作ります。

なので、(jsk),(rbrain)のそれぞれで定義されるクラスのhtmlを作るには
irteusgl doctools.l
と、irteusglで使う必要があります。

documentation.l

今度は
defun symbol [documentation] lambda-list . body
のdocumentationをただ表示するだけ，という作戦にでてみました．
以前はdoxygenを使ってクラス構造を表示しようとしていましたが，
結局ドキュメントすら出来てないということで，一番簡単なシンプル
バージョンを狙います．
（じつはeus/doc/funcs というファイルがあって，これにdocumentatoinが入れば出来ればOK）

cd euslib/irteus_proposals/
irteusgl documentation.l > documentation.txt
documentation.txt行頭の;;部分を抜いて行頭が
=====ここから
public functions

!
=====ここまで
となるようにして，
rst2pdf documentation.txt
として５分ぐらいかな？まつとと，添付のpdfが作られます．

eus/lisp/l/eusdebug.l に定義されている

pfuncs

という関数で，eus/doc/funcs というファイルが作られていそうだ．

[k-okada]

docclass

[k-okada]

Ticket moved from /p/jskeus/bugs/8/

Can't be converted:

• _milestone:
• _priority: 5