種類
- 特異メソッド (18)
- インスタンスメソッド (9)
- クラス (2)
クラス
-
RDoc
:: CodeObject (1) -
RDoc
:: Context (2) -
RDoc
:: Context :: Section (1) -
RDoc
:: Generator :: JsonIndex (1) -
RDoc
:: Markdown (3) -
RDoc
:: Markup (4) -
RDoc
:: Markup :: Formatter (2) -
RDoc
:: Markup :: ToAnsi (1) -
RDoc
:: Markup :: ToBs (1) -
RDoc
:: Markup :: ToHtml (1) -
RDoc
:: Markup :: ToHtmlCrossref (1) -
RDoc
:: Markup :: ToRdoc (1) -
RDoc
:: Options (1) -
RDoc
:: Parser (1) -
RDoc
:: Parser :: C (1) -
RDoc
:: Parser :: Ruby (1) -
RDoc
:: Parser :: Simple (1) -
RDoc
:: Stats (1) -
RDoc
:: TopLevel (1)
モジュール
-
RDoc
:: Text (1)
キーワード
- Markup (1)
- RDoc (1)
-
add
_ html (1) -
add
_ special (1) -
add
_ tag (1) -
add
_ word _ pair (1) -
alias
_ extension (1) -
break
_ on _ newline (1) -
break
_ on _ newline= (1) -
ongoing
_ visibility= (1) - parse (1)
-
strip
_ newlines (1)
検索結果
先頭5件
- RDoc
:: CodeObject . new -> RDoc :: CodeObject - RDoc
:: Context . new -> RDoc :: Context - RDoc
:: Context :: Section . new(parent , title , comment) -> RDoc :: Context :: Section - RDoc
:: Generator :: JsonIndex . new(parent _ generator , options) -> RDoc :: Generator :: JsonIndex - RDoc
:: Markdown . new(extensions = DEFAULT _ EXTENSIONS , debug = false)
-
RDoc
:: CodeObject . new -> RDoc :: CodeObject (54307.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: Context . new -> RDoc :: Context (54307.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: Context :: Section . new(parent , title , comment) -> RDoc :: Context :: Section (54307.0) -
自身を初期化します。
...自身を初期化します。
@param parent RDoc::Context オブジェクトを指定します。
@param title section のタイトルを文字列で指定します。
@param comment section のコメントを文字列で指定します。
また、section のシーケンス番号を新しく... -
RDoc
:: Generator :: JsonIndex . new(parent _ generator , options) -> RDoc :: Generator :: JsonIndex (54307.0) -
RDoc::Generator::JsonIndex オブジェクトを初期化します。
...
RDoc::Generator::JsonIndex オブジェクトを初期化します。
@param parent_generator 親となるジェネレータオブジェクトを指定します。
RDoc::Generator::JsonIndex#class_dir や
#file_dir を決めるのに使用します......。
他のジェネレータとは異なり、RDoc::Store
オブジェクトではない点に注意してください。
@param options RDoc::Options オブジェクトを指定します。
parent_generator に渡されたものと同... -
RDoc
:: Markdown . new(extensions = DEFAULT _ EXTENSIONS , debug = false) (54307.0) -
引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブ ジェクトを初期化します。
...引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブ
ジェクトを初期化します。
@param extensions 有効にする拡張を Symbol の配列で指定します。
@param debug デバッグを有効にするかどうかを指定します。... -
RDoc
:: Markup . new(attribute _ manager = nil) -> RDoc :: Markup (54307.0) -
自身を初期化します。
...自身を初期化します。
@param attribute_manager Rdoc::AttributeManager オブジェクトを指
定します。... -
RDoc
:: Markup :: Formatter . new(markup = nil) -> RDoc :: Markup :: Formatter (54307.0) -
自身を初期化します。
...自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。... -
RDoc
:: Markup :: ToAnsi . new(markup = nil) -> RDoc :: Markup :: ToAnsi (54307.0) -
自身を初期化します。
...自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。... -
RDoc
:: Markup :: ToBs . new(markup = nil) -> RDoc :: Markup :: ToBs (54307.0) -
自身を初期化します。
...自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。... -
RDoc
:: Markup :: ToHtml . new -> RDoc :: Markup :: ToHtml (54307.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: Markup :: ToHtmlCrossref . new(path , context , show _ hash) -> RDoc :: Markup :: ToHtmlCrossref (54307.0) -
自身を初期化します。
...自身を初期化します。
@param path 生成するファイルのパスを文字列で指定します。
@param context RDoc::Context オブジェクトかそのサブクラスのオブジェ
クトを指定します。
@param show_hash true を指定した場合、メソッ... -
RDoc
:: Markup :: ToRdoc . new(markup = nil) -> RDoc :: Markup :: ToRdoc (54307.0) -
自身を初期化します。
...自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。... -
RDoc
:: Parser :: C . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: C (54307.0) -
自身を初期化します。
...op_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats... -
RDoc
:: Parser :: Ruby . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: Ruby (54307.0) -
自身を初期化します。
...op_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body ソースコードの内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats... -
RDoc
:: Parser :: Simple . new(top _ level , file _ name , body , options , stats) -> RDoc :: Parser :: Simple (54307.0) -
自身を初期化します。
...@param top_level RDoc::TopLevel オブジェクトを指定します。
@param file_name ファイル名を文字列で指定します。
@param body 内容を文字列で指定します。
@param options RDoc::Options オブジェクトを指定します。
@param stats RDoc::Stats オブジ... -
RDoc
:: Stats . new -> RDoc :: Stats (54307.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: TopLevel . new(file _ name) -> RDoc :: TopLevel (54307.0) -
自身を初期化します。
自身を初期化します。
@param file_name ファイル名を文字列で指定します。 -
RDoc
:: Markdown # break _ on _ newline -> bool (18304.0) -
改行を保持した状態で出力するかどうかを返します。
改行を保持した状態で出力するかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # break _ on _ newline=(val) (18304.0) -
改行を保持した状態で出力するかどうかを設定します。
改行を保持した状態で出力するかどうかを設定します。 -
RDoc
:: Text # strip _ newlines(text) -> String (18304.0) -
引数から先頭と末尾の改行を削除します。
引数から先頭と末尾の改行を削除します。
@param text 文字列を指定します。 -
RDoc
:: Parser . alias _ extension(old _ ext , new _ ext) -> bool (373.0) -
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登 録します。
old_ext に登録されたパーサを new_ext でも解析できるようにエイリアスを登
録します。
@param old_ext 拡張子を文字列で指定します。
@param new_ext 拡張子を文字列で指定します。
@return エイリアスが登録された場合は true を返します。old_ext にパーサ
が登録されていない場合、エイリアスが登録されずに false を返しま
す。 -
RDoc
:: Markup (58.0) -
RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。
...RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。
例:
require 'rdoc/markup/to_html'
h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)
独自のフォーマットを行うようにパーサを拡張する事もできます。
例:
req......uire 'rdoc/markup'
require 'rdoc/markup/to_html'
class WikiHtml < RDoc::Markup::ToHtml
# WikiWord のフォントを赤く表示。
def handle_special_WIKIWORD(special)
"<font color=red>" + special.text + "</font>"
end
end
m = RDoc::Markup.new
# { 〜 } までを :STRIK......STRIKE のフォーマットを <strike> 〜 </strike> に指定。
wh.add_tag(:STRIKE, "<strike>", "</strike>")
puts "<body>#{wh.convert ARGF.read}</body>"
変換する形式を変更する場合、フォーマッタ(例. RDoc::Markup::ToHtml)
を変更、拡張する必要があります。... -
RDoc
:: Context # ongoing _ visibility=(vis) (52.0) -
Change the default visibility for new methods
Change the default visibility for new methods -
RDoc
:: Markup # add _ html(tag , name) -> () (40.0) -
tag で指定したタグをフォーマットの対象にします。
...::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。
例:
require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_html("no", :STRIKE)
h = SM::ToHtml.new
h.add_tag(:STRIKE,... -
RDoc
:: Markup # add _ special(pattern , name) -> () (40.0) -
pattern で指定した正規表現にマッチする文字列をフォーマットの対象にしま す。
...::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。
例:
require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
class WikiHtml < SM::ToHtml
def handle_special_WIKIWORD(special)
"<font color=red>" +... -
RDoc
:: Markup # add _ word _ pair(start , stop , name) -> () (40.0) -
start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま す。
...ます。
@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。
例:
require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_word_pair("{", "}", :STRIKE)
h = SM::ToHtml.new
h.add_tag(:S... -
RDoc
:: Markup :: Formatter # add _ tag(name , start , stop) -> () (22.0) -
name で登録された規則で取得された文字列を start と stop で囲むように指 定します。
...@param name RDoc::Markup::ToHtml などのフォーマッタに識別させる時
の名前を Symbol で指定します。
@param start 開始の記号を文字列で指定します。
@param stop 終了の記号を文字列で指定します。
例:
require 'rdoc/markup/to_html......'
# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup::ToHtml.new
h.add_tag(:STRIKE, "<strike>", "</strike>")... -
RDoc
:: Options # parse(argv) -> () (22.0) -
コマンドライン引数を解析します。
コマンドライン引数を解析します。
@param argv コマンドライン引数を文字列の配列で指定します。
また、以下のような指定をした場合は標準エラーに出力を行い、終了コード 1
でプログラムを終了します。
* --extension オプションに拡張子を 2 つ指定しなかった場合
* --extension オプションに new=old を指定した時に old を扱えるフォーマッ
タがない場合
* --fmt オプションに扱えない出力を指定した場合 -
RDoc
:: RDoc (22.0) -
rdoc ドキュメントの作成を行うクラスです。
...rdoc ドキュメントの作成を行うクラスです。
以下のようにして、rdoc コマンドを実行するのと同様に実行します。
require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)
args には rdoc コマンドに渡すのと同様の引数を文字列......の配列で指定します。
rdoc コマンドと同様に変換結果はファイルに出力されるため、テキストを
HTML に変換する部分をライブラリとして使用したい場合、
rdoc/markup を参照してください。...