検索結果

rdoc/markup/to_rdoc (44022.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• ライブラリ

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための サブライブラリです。

...RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
サブライブラリです。

サブクラス(RDoc::Markup::ToAnsi など)を作成して使います。...

• RDoc::Markup::ToRdoc

RDoc (44016.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• モジュール

rdoc ドキュメントを扱うためのモジュールです。

...rdoc ドキュメントを扱うためのモジュールです。...

rdoc/rdoc (44016.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• ライブラリ

rdoc コマンドのためのサブライブラリです。

...rdoc コマンドのためのサブライブラリです。...

• RDoc::RDoc
• e2mmap
• fileutils
• find
• irb/notifier
• irb/output-method
• irb/slex
• optparse
• pathname
• rdoc
• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/code_objects
• rdoc/constant
• rdoc/context
• rdoc/ghost_method
• ...

rdoc/parser/rd (38000.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• ライブラリ

RD 形式で記述されたファイルを解析するためのサブライブラリです。

...RD 形式で記述されたファイルを解析するためのサブライブラリです。...

• RDoc::Parser::RD

rdoc (32374.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• ライブラリ

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。

...RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。

このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby...

...てきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、この部分は取り替え可能にでき
ています)。Markup とはプレーンテ...

...トに変換するた
めのライブラリです。RDoc によってメソッドやクラスに関するドキュメントを
生成するとき、コメント部を変換するために使われます。

=== ロードマップ

* RDoc で Ruby のソースファイルに対するドキュメン...

• RDoc
• RDoc::Error
• rdoc/alias
• rdoc/anon_class
• rdoc/any_method
• rdoc/attr
• rdoc/class_module
• rdoc/code_object
• rdoc/code_objects
• rdoc/constant
• rdoc/context
• rdoc/generator
• rdoc/generator/darkfish
• rdoc/generator/json_index
• rdoc/generator/markup
• rdoc/generator/ri
• rdoc/ghost_method
• rdoc/include
• rdoc/known_classes
• rdoc/markdown
• ...

絞り込み条件を変える

rdoc/generator (32182.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• ライブラリ

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::Generator
• rdoc/generator/darkfish
• rdoc/generator/json_index
• rdoc/generator/markup
• rdoc/generator/ri

rdoc/markup (32094.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• ライブラリ

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::ToHtml...

• RDoc::Markup
• rdoc/markup/formatter
• rdoc/markup/to_ansi
• rdoc/markup/to_bs
• rdoc/markup/to_html
• rdoc/markup/to_html_crossref
• rdoc/markup/to_rdoc

rdoc/markdown (32088.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• ライブラリ

Markdown 形式で記述されたドキュメントを rdoc 上で解析するための サブライブラリです。

...Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
サブライブラリです。

詳しくは以下を参照してください。

* https://daringfireball.net/projects/markdown/syntax

Markdown 形式をデフォルトのフォーマットにする場合は...

...、
lib:rdoc#saved_options を参考に プロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。

=== 拡張

以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効に...

...== RDoc

RDoc の Markdown のパーサは以下の無効にできない機能があります。

Underscores embedded in words are never interpreted as emphasis. (While the
[markdown dingus][dingus] emphasizes in-word underscores, neither the
Markdown syntax nor MarkdownTest mention this behavior....

• RDoc::Markdown
• rdoc
• rdoc/markdown/entities
• rubygems
• rubygems/builder
• rubygems/defaults
• rubygems/dependency
• rubygems/digest/sha2
• rubygems/exceptions
• rubygems/gem_path_searcher
• rubygems/platform
• rubygems/remote_fetcher
• rubygems/requirement
• rubygems/source_index
• rubygems/source_info_cache
• rubygems/source_info_cache_entry
• rubygems/spec_fetcher
• rubygems/specification
• rubygems/user_interaction
• rubygems/version

rake/rdoctask (32078.0)

• 2.2.0
• 2.3.0
• 2.4.0
• 3.3

• ライブラリ

ドキュメントを作成するためのタスクを定義します。

...: rdoc
RDoc を作成します。
: clobber_rdoc
生成された RDoc のファイルを削除します。
このタスクは clobber タスクにも追加されます。
: rerdoc
既に存在する RDoc が古くなくても RDoc を作成します。


例:
Rake::RDocTask.new do |rd|...

...rd.main = "README.rdoc"
rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
end

例:
# RDoc タスクに別の名前を付ける例
Rake::RDocTask.new(:rdoc_dev) do |rd|
rd.main = "README.doc"
rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
rd.options << "--all...

• Rake::RDocTask
• rake
• rake/tasklib