60件ヒット
[1-60件を表示]
（0.012秒）
:![[x]](/images/drop-condition-icon.png "条件を削除"){kind=icon}
:ライブラリキーワード
-
rdoc
/ generator (12) -
rdoc
/ markdown (12) -
rdoc
/ markup (12) -
rdoc
/ markup / to _ html _ crossref (12)
検索結果
-
rdoc (38381.0)
-
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。
...RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。
このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby......ットに変換するた
めのライブラリです。RDoc によってメソッドやクラスに関するドキュメントを
生成するとき、コメント部を変換するために使われます。
=== ロードマップ
* RDoc で Ruby のソースファイルに対するドキュメ......ブラリを含めたければ、rdoc/parser/c を参照してください。
* コメント部で使えるマークアップについて知りたければ、rdoc/markup を参照してください。
* RDoc をライブラリとして使いたければ、RDoc::RDoc を参照してください。... -
rdoc
/ markup / to _ html _ crossref (12023.0) -
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
...RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。... -
rdoc
/ generator (6189.0) -
RDoc が解析したソースコードを RDoc::CodeObject のツリーから その他の形式に出力するためのサブライブラリです。
...RDoc が解析したソースコードを RDoc::CodeObject のツリーから
その他の形式に出力するためのサブライブラリです。
RDoc には HTML 向けのジェネレータの
RDoc::Generator::Darkfish と ri 向けのジェネレータの
RDoc::Generator::RI が付属して......ネレータの登録
RDoc::RDoc.add_generator を呼び出す事でジェネレータの登録が行えます。
class My::Awesome::Generator
RDoc::RDoc.add_generator self
end
=== rdoc のオプションの追加
rdoc ではオプションの処理の前に RDoc::Options は各ジェネ......る RDoc::Options#option_parser に対して rdoc コマンドのオプ
ションを追加できます。lib:rdoc/options#custom_options の例と
OptionParser も併せて参照してください。
=== ジェネレータのインストール
ソースコードを解析した後は RDoc:RDoc オ... -
rdoc
/ markup (6143.0) -
RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。
...RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。
RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の
FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行う
ツ......基礎として作られています。RDoc::Markup 自身は何の出力も
行いません。
それらは output_format で後述するクラス群に委ねられています。
=== Markup
基本的には、lib:rdoc#markup と同じです。ただし、rdoc コマンドと
は異なり、Ruby......。
* lib:rdoc#list
* lib:rdoc#labeled_list
* lib:rdoc#headline
* lib:rdoc#ruled_line
* lib:rdoc#italic_bold_typewriter
* lib:rdoc#escape
===[a:output_format] 出力可能な形式
変換する形式として以下のいずれかを選択できます。
* HTML 形式: RDoc::Markup::ToHtm... -
rdoc
/ markdown (6095.0) -
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための サブライブラリです。
...ドキュメントを rdoc 上で解析するための
サブライブラリです。
詳しくは以下を参照してください。
* https://daringfireball.net/projects/markdown/syntax
Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参......ルトを
.rdoc_options ファイルで設定してください。
=== 拡張
以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効になっている訳ではありません。
==== RDoc
RDoc の Markdow......を記述すると HTML を出力する際に自動でリンクを作成します。URL
はそのまま表示されます。
==== Break on Newline
RDoc::Markdown#break_on_newline を設定する事で改行を保持した状態
で出力が行えます。詳しくは以下を参照してくださ...