いがらしです。

なんかrubyapiの存在がドキュメント整備の停滞の
原因になってしまっているので、罪滅ぼしということで。

At Fri, 8 Oct 1999 11:08:01 +0900,
in [ruby-list:17520] Re: Ruby Library Manual,
matz / netlab.co.jp (Yukihiro Matsumoto) wrote:
> 
> In message "[ruby-list:17514] Re: Ruby Library Manual"
>     on 99/10/08, TAKAHASHI Masayoshi <maki / inac.co.jp> writes:
> 
> |そうですね。五十嵐さんのメールもありましたが、とりあえず
> |ライブラリだったらRDでもいいですから、「Description」と
> |「Usage」に当たるものを書いてあればうれしいかな、と。はい。
> 
> そうですね。

rubyapiはとりあえず忘れて^_^;;  RDで書いていきましょうか。
形式がそろわないかも知れませんが、ないよりいいということで。

もう少しRDを使ってみた上で、どうしても要求が満たせそうにないなら
RDを拡張するなりrubyapi的なものに移行するなりしましょう。
# 個人的にはrubyapi的な方向でもあれこれ試してみるつもりですけど。

> |現状のものについても、RD形式で、必要な情報を付け加えていくことに
> |なるんでしょうか?
> 
> 時間がとれれば、作業にかかります。ボランティア歓迎。

とりあえず$(srcdir)/lib/READMEを参考にして、
簡単な添付ライブラリのリストを作ってみました。
意図的に*.rb, *.soの区別はしていません。
# categorizeする意味はなかったかも。
追加・訂正ありましたらお願いします。

これもRuby/GTK Tutorialの英訳のように、
ここで名乗り上げて分担していったらいいんでしょうか。
問題は誰がそれをまとめるかですが……

--
五十嵐  宏  (Hiroshi IGARASHI)


○組み込みライブラリ(まだ説明のないもの) Binding FalseClass TrueClass (Continuaion) ○添付ライブラリ ドキュメント(英語・日本語どちらかあれば「あり」) html ruby-manにHTML形式で含まれている plain 拡張ライブラリでソースにplain textのマニュアルが添付 comment スクリプト中にコメント形式(≠RD)で含まれている rd RD形式で添付 feature名 概要 ドキュメント ------------------------------------------------------------------------ [数学] mathn 数学計算ライブラリ matrix 行列計算ライブラリ あり(comment) rational 有理数サポート あり(comment) complex 複素数サポート あり(comment) [IO] readbytes IO#readbytesを定義 [ネットワーク] socket BSDソケットインタフェイス あり(html) cgi-lib CGIデータのデコード あり(rd) cgi CGI あり(rd) ftplib FTPアクセスライブラリ あり(html) mailread メールヘッダ解析 net/session セッション管理 net/pop POP net/smtp SMTP ping ホストが動作しているかを調べる あり(rd) telnet telnetプロトコル あり(rd) [ファイルアクセス] fcntl fcntl.hにある定数を提供する ftools mv, cp, etc相当のファイル操作 tempfile 自動的に消える一時ファイル あり(comment) find ディレクトリの再帰的走査 あり(comment) [DBM] dbm あり(html) gdbm (dbmと同じ使い方) sdbm (dbmと同じ使い方) [日付・時刻] date 日付クラス date2 もう一つの日付クラス parsedate 日付文字列の解析 [文字列操作] jcode Stringの日本語文字列対応 eregex 正規表現クラスの拡張(obsolete) base64 base64 encode/decode nkf 日本語文字列の符合系変換 あり(html) md5 メッセージダイジェスト あり(plain) [環境へのアクセス] shellwords シェル風引数分解 getopts コマンドラインオプション解析 あり(html) parsearg getoptsの強化版 あり(html) getoptlong GNU getoptlong互換 importenv 環境変数を大域変数としてアクセス Env (importenvと同一) [オブジェクト操作] ostruct python形式のオブジェクト observer observerパターン delegate メッセージの委譲 singleton singletonパターン weakref weak referenceクラス pstore オブジェクトの永続化 final ファイナライザの追加(簡易版) finalize ファイナライザの追加 e2mmap 例外ユーティリティ [スレッド] thread Mutex/ConditionVariable/Queue あり(html) thwait スレッドの同期 あり(comment) timeout タイムアウトつきブロック実行 あり(comment) monitor 排他制御モニタ あり(comment) mutex_m mutex mixin あり(comment) sync 2相ロック あり(comment) [プロセス] open3 子プロセスとの接続 あり(comment) [端末] curses cursesライブラリ pty pty経由でのコマンド実行 あり(plain) readline GNU Readline Library あり(plain) [GUI] tcltklib Tkインタフェイス tk Tkインタフェイス [OS] Win32API Win32 APIを呼び出す etc /etc/{passwd,group}にアクセス あり(plain) [デバッグ] debug デバッガ tracer 実行トレーサ profile プロファイラ [拡張ライブラリ] mkmf 拡張ライブラリ用makefileの生成 [その他] English 大域変数に英語の別名をつける rbconfig ruby本体のconfiguration情報 [irb] irb/completion irb/frame フレーム情報にアクセスする irb/input-method irb/loader irb/main irb/multi-irb irb/ruby-lex rubyのトークン解析 irb/ruby-token rubyのトークン irb/slex 簡易なrubyのトークン解析器 irb/workspace-binding-2 irb/workspace-binding irb/xmp