るりまサーチ

最速Rubyリファレンスマニュアル検索!
65件ヒット [1-65件を表示] (0.017秒)
トップページ > クエリ:ref[x] > クエリ:rdoc[x] > クエリ:Options[x]

別のキーワード

  1. rexml/document ref
  2. fiddle ref
  3. entity ref
  4. pointer ref
  5. _builtin _id2ref

ライブラリ

クラス

キーワード

検索結果

rdoc (38452.0)

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

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

このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby...
...ットに変換するた
めのライブラリです。RDoc によってメソッドやクラスに関するドキュメントを
生成するとき、コメント部を変換するために使われます。

=== ロードマップ

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

RDoc::Options (21154.0)

rdoc コマンドのオプションを解析するためのクラスです。

...rdoc コマンドのオプションを解析するためのクラスです。

それぞれのオプションの詳細に関しては、lib:rdoc#usage を参照してくだ
さい。


===[a:custom_options] カスタムオプション

RDoc
のジェネレータでは、RDoc::Options をフックし...
...まれていた場合、RDoc はジェネ
レータ独自のオプションを解析するために setup_options メソッドを呼び出し
ます。カスタムオプションを指定する場合は --format オプションは必ず指定
する必要があります。rdoc --help を実行する...
...

例:

class RDoc::Generator::Spellcheck
RDoc
::RDoc.add_generator self

def self.setup_options rdoc_options
op = rdoc_options.option_parser

op.on('--spell-dictionary DICTIONARY',
RDoc
::Options::Path) do |dictionary|
# RDoc::Options に spell_dictionary...

rdoc/generator (6224.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 は各ジェネ...
...レータの #setup_options メソッドを実行します。ジェネレータは 第一引数で
渡される RDoc::Options#option_parser に対して rdoc コマンドのオプ
ションを追加できます。lib:rdoc/options#custom_options の例と
OptionParser も併せて参照してくだ...

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

RDoc::RDoc.add_generator(klass) -> klass (6024.0)

引数 klass で指定したクラスをジェネレータとして登録します。

...引数 klass で指定したクラスをジェネレータとして登録します。

@param klass 登録するクラスを指定します。

@see c:RDoc::Options#custom_options...

絞り込み条件を変える

NEWS for Ruby 3.0.0 (66.0)

NEWS for Ruby 3.0.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。

...rdoc-ref:doc/syntax/comments.rdoc@Magic+Comments] for more details.
17273
* A {static analysis}[rdoc-label:label-Static+analysis] foundation is
introduced.
* {RBS}[rdoc-label:label-RBS] is introduced. It is a type definition
language for Ruby programs.
* {TypeProf}[rdoc...
...a SyntaxError instead of
a warning.

== Command line options

=== `--help` option

When the environment variable `RUBY_PAGER` or `PAGER` is present and has
a non-empty value, and the standard input and output are tty, the `--help`
option s
hows the help message via the pager designated by the va...
...uler hooks in a non-blocking context. 16786
* Ractor
* New class added to enable parallel execution. See rdoc-ref:ractor.md for more details.
* Random
* `Random::DEFAULT` now refers to the `Random` class instead of being a `Random` instance, so it can work with `Ractor`. 17322
* `Ran...