問題タブ [rdoc]

JRubyを介してRubyスクリプトに公開される既存のJavaクラスがあり、Javaオブジェクトを使用するRuby開発者にRDocスタイルのドキュメントを提供できるようにしたいと思います。

JavaクラスからRDocドキュメントを生成することは可能ですか？または、それらのスタブバージョンをそれらに対して標準のRDocを実行できるrubyクラスとして維持/生成する必要がありますか？

バージョン3.5.3を使用して、rdocドキュメントをきれいにしようとしています。私は組み込みのdarkfishテーマのファンではないので、http：//api.rubyonrails.org/にある公式のRails APIドキュメントで使用されているテーマに置き換える方法を見つけようとしましたが、すぐに利用できる形でそれを見つけることができませんでした。とりわけ、github全体を検索しました。

私がこれまでに見つけたのは

• https://github.com/mislav/hanna

少し古くなっているかもしれませんが、フォークです

• https://github.com/rdoc/hanna-nouveau

どちらも素晴らしいですが、私が望むものではありません。それで、これらのテンプレートをいじり始める前に、Rails APIドキュメントで使用されているテンプレートがどこかで宝石として利用できるかどうか誰かが知っていますか？

ありがとう！

Ruby on Rails 3.0.7 を使用していますが、アプリケーションを文書化するために (デフォルトではなく) 新しい RDoc テンプレートをインストールして使用したいと考えています。

次のいずれかを選択したいと思います。

• http://api.rubyonrails.org/
• http://www.ruby-doc.org/core/
• ...あなたがアドバイスする他の人

そう、

1. 上記のテンプレートはどこで入手できますか?
2. どうすればそれをインストールできますか?
3. .rake選択したテンプレートでドキュメントを生成するには、ファイルにどのコードを配置すればよいですか?

一言で言えば、私はこの問題の初心者です。

この時点で、Gemfile で次のように述べています。

コマンドを実行しbundle installます。

@dmarkowの更新I

horo gemをインストールし、次のコードを my.rakeファイルに挿入しました。

コマンドを実行すると、次のようrdoc -f horo --main README.rdoc *.rdoc lib extになります。

コマンドを実行すると、次のようrake doc:appになります。

@dmarkowのUPDATE II

docディレクトリを削除しました：

コマンドを実行すると、次のようrdoc -f horo --main README.rdoc *.rdoc lib extになります。

ドキュメント ディレクトリにcreated.ridファイルを作成します。

コマンドを実行するrake doc:appと、次の UPDATE と同じ結果になります。

私がしなければならないこと？まだgem "rdoc", "~> 3.6.1"Gemfile に保持する必要がありますか?

現在、いくつかの Ruby コードを文書化しています。「ホスト」と呼ばれるメソッドを持つ 2 つのクラスがあります。

これらのクラスの 1 つで、メソッドに特別なコメントが必要です。他のクラスでは、最初のクラスを参照し、その参照をそのクラスへのリンクにしたいと思います。

通常、rdoc では、メソッドの名前を入力するだけでリンクを生成できます。この場合、Class::SubClass.hostリンクを書き出しても、現在のクラスのメソッドを指すことを主張しています。

これを行う方法を知っている rdoc マスターはいますか?

のメソッドFakeTown::Apiにリンクしたい場所の例を次に示します。RealTown::Api#host

#hostrdoc によって作成されたリンクは、このドキュメントのメソッドに直接戻るという役に立たないリンクです。

ありがとう！

ri / rdocファイルを持たないgemがいくつかありますが、このrdocファイルをインストールする方法があるかどうか知りたいです。

Ruby on Rails 3.0.7 を使用しており、 RDocシステムのしくみを理解しようとしています。したがって、公式ドキュメントが7行目でそれを参照している場合、「ハッシュ」値が何を意味するのかを理解したいと思います:

1. クラス、ソース ファイル、およびアンダースコアを含むかハッシュ文字が前に付いたメソッド名の名前は、 コメント テキストからそれらの説明に自動的にハイパーリンクされます。

コメントされたコードでそれを述べる例を教えてもらえますか? その使い方について何かアドバイスはありますか？

ところで：RDocを参照する「MUST READ」リソースはありますか？もしそうなら、あなたはそれを提供できますか？

Ruby on Rails 3.0.7を使用していますが、アプリケーションを文書化したいと思います。そのためには、 RDocに関する「優れた」ドキュメントを見つける必要があります。

どこで見つけることができますか？つまり、RDocに関するドキュメントを見つけるための「最良の」Webリソースは何ですか？

私は Ruby on Rails 3.0.7 を使用しており、RDocを使用してアプリケーションのドキュメントを作成しています。Web 上で例を含む優れたドキュメントを見つけられなかったので、私が知りたいのは、:include:ディレクティブの使用方法です。

アプリケーションファイルでそれを使用する例を教えてもらえますか?

Ruby on Rails 3.0.7 を使用しており、RDoc を使用してアプリケーションのドキュメントを作成しています。私のアプリケーションファイルには次のものがあります：

私のアプリケーションのドキュメントを生成すると、上記のコメント付きのコードは、それらが表示されるはずの段落ブロックの外に出class User < ActiveRecord::Baseてしまいます。end

以下は、関連するスクリーン ショットです。

どうすれば解決できますか？

これを使用すると、同じ出力（クラスステートメントが表示される段落ブロックの外側）が得られます

またはこれ

RDoc を使用して、Ruby on Rails 3.0.7 アプリケーションのドキュメントを作成しています。アプリケーションlibフォルダーには、次のものがあります。

#'CONSTANT' documentation text上記のコードのドキュメントを生成しようとすると、RDoc は と を解析しない#'method_name' documentation textため、出力ドキュメントは空白になります。

1. モジュール「コンテキスト」内のコメント化されたコードを RDoc で考慮するにはどうすればよいですか?

:doc:次のようにディレクティブを使用しても役に立ちません。

Class\Module Indexにこれらがあることに注意してください。

2. どういう意味ですか?