種類:ライブラリ > クエリ:RDoc

616件ヒット [1-100件を表示] （0.099秒）

トップページ >

:ライブラリ

:RDoc

別のキーワード

キーワード

検索結果

<< 1 2 3 ... > >>

rdoc/markup/to_rdoc (12023.0)

ライブラリ

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

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

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

rdoc/rdoc (12017.0)

ライブラリ

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

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

rdoc (6369.0)

ライブラリ

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

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

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

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

=== ロードマップ

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

...ブラリを含めたければ、rdoc/parser/c を参照してください。
* コメント部で使えるマークアップについて知りたければ、rdoc/markup を参照してください。
* RDoc をライブラリとして使いたければ、RDoc::RDoc を参照してください。...

rdoc/generator (6183.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 (6095.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 (6089.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 を設定する事で改行を保持した状態
で出力が行えます。詳しくは以下を参照してくださ...

rake/rdoctask (6079.0)

ライブラリ

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

...す。

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

rdoc/parser (6071.0)

ライブラリ

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

...rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

以下のメソッドを定義したクラスを作成する事で、新しいパーサクラスを作成
する事ができます。

* #initialize(top_level, file_name, body, options, stats)
* #sc...

...* top_level RDoc::TopLevel オブジェクトを指定します。
* file_name: file_name ファイル名を文字列で指定します。
* body: ソースコードの内容を文字列で指定します。
* options: RDoc::Options オブジェクトを指定します。
* stats: RDoc::Stats...

...ん。処理の後は必ず
RDoc::TopLevel オブジェクトを返す必要があります。

また、RDoc::Parser はファイル名からパーサクラスを取得するのにも使
われます。このために、新しく作成するパーサクラスでは RDoc::Parser
を継承し、parse...

rubygems/commands/rdoc_command (6053.0)

ライブラリ

RDoc と ri のライブラリを生成するためのライブラリです。

...RDoc と ri のライブラリを生成するためのライブラリです。

Usage: gem rdoc [args] [options]
Options:
--all インストールされている全ての Gem パッケージの
RDoc/RI ドキュメント...

...を生成します。
--[no-]rdoc RDoc を含めます
--[no-]ri RI を含めます
-v, --version VERSION 指定したバージョンのドキュメントを生成します
Common Options:
-h, --help...

...ドキュメントを生成する Gem パッケージを指定します。省略すると全ての
Gem パッケージのドキュメントを生成します。
Summary:
RDoc/RI ドキュメントを生成します
Defaults:
--version '>= 0' --rdoc --ri...

rdoc/context (6033.0)

2.6.0

ライブラリ

RDoc::Context と RDoc::Context::Section を定義するサブライブラリです。

...RDoc::Context と RDoc::Context::Section を定義するサブライ
ブラリです。...

絞り込み条件を変える

<< 1 2 3 ... > >>

別のキーワード

キーワード

検索結果

先頭5件

rdoc/markup/to_rdoc (12023.0)

rdoc/rdoc (12017.0)

rdoc (6369.0)

rdoc/generator (6183.0)

rdoc/markup (6095.0)

rdoc/markdown (6089.0)

rake/rdoctask (6079.0)

rdoc/parser (6071.0)

rubygems/commands/rdoc_command (6053.0)

rdoc/context (6033.0)