問題タブ [yard]

ドキュメントの目的で、Ruby onRails3.1.0とYARD0.7.4gemを使用しています。別のパラメータからパラメータ（タグ）を参照したいのですが。つまり、私は持っています：@param

出来ますか？もしそうなら、どうすればそれを作ることができますか？

Rails 3.1.0 を使用しており、機能するプラグインを実装しています。実行する必要があるだけでなく、その関連ファイルはROOT_APP/vendor/plugins/my_pluginディレクトリにあります。

現在、私はYARD 0.7.4 gem を使用しており、そのプラグインを文書化したいと思います。とにかく、yardoc(またはyard doc) コマンドを実行すると、プラグインが考慮されていないように見えるため、関連ドキュメントは生成されません (「メイン」アプリケーションに関連するドキュメントのみが生成されます)。

プラグインに関連するドキュメントを生成するにはどうすればよいですか?

--privateスイッチが動作しないことがわかった最初の質問ではyard server、どのように動作させるのですか?

次に、 を使用する代わりに を使用してドキュメント ファイルを生成することを選択した場合、で--privateスイッチが機能することに気付きました。 レンダリング ドキュメントにフレームを持たせる方法 (サイド バー)yard docyard docyard server

<label>Yardによって生成されたrubyクラスのドキュメントに、などのHTML要素名を含めたいと思います。しかし、それは機能していません。たとえば、文

ヤードで処理した後になる

要素は実際には<label>ヤードをそのまま通過し、生のHTMLとしてブラウザに渡されます。

<label>代わりに使用してみましたが、それが回避されたため<label>、結果のドキュメントにまとめられました。

ありがとう！

YARDは、アプリ全体の優れたドキュメントを生成するための gem です。

しかし、XML と JSON をサポートする API 呼び出しのドキュメントを生成しようとしています...オブジェクトとそのパラメーターの説明へのリンクなどを含めます。これを行う方法はありますか?

それとも、ヤードで API ドキュメントのみを生成するための秘密のコマンドですか?

YARDを使用すると、メソッドパラメータと戻り値のタイプを指定できます。私は本当にダックタイピングが好きなので、YARDがサポートしなければならないメソッドを指定することでタイプの定義もサポートしているのを見るのはうれしいです。

ご覧のとおり、次のような表現

��理和として解釈されます。これは、オブジェクトが#first_methodまたは#second_method、あるいはその両方をサポートする必要があることを意味します。これは私が必要としているものではありません。

パラメータの#first_methodと#second_methodの両方をサポートするためにオブジェクトが必要であることを指定できるようにしたいと思います。これを指定する方法はありますか？

ドキュメントの目的で、Ruby onRails3.1.0とYARD0.7.4gemを使用しています。ここでREADME作成したように、生成されたドキュメントの上部にあるファイル以外のファイルを追加したいと思います（「ファイルリスト」セクションの下のリンクされたページの上部にある、、、、、 ...タブを参照してください）。READMEWhat's New?Getting Started GuideArchitecture Overview

つまり、デフォルトでは、YARD gemはREADME、RoRアプリケーションのROOTディレクトリにあるファイルに関連するドキュメントのみを生成するようです。他のファイルをドキュメント化したいのですが、それぞれについて、ドキュメントの上部にタブを追加します（以前にリンクされたページで作成されたように）。

出来ますか？もしそうなら、どうすればそれを作ることができますか？さらに、ドキュメント化の目的で使用される「カスタム」ファイルを含む新しいディレクトリを（RoRアプリケーションのROOTに）作成する必要がありますか？

I am using Ruby on Rails 3.1.0 and the YARD 0.7.4 gem for documentation purposes. I implemented a working plugin (in the ROOT_APP/vendor/plugins/<plugin_name> directory) and I would like to document that plugin.

Note: When I run the yard doc Terminal command from the root directory of my application in order to generate documentation files, the YARD gem doesn't generate the documentation related to my plugin (all other documentation files are properly generated).

So, is it possible to document plugins? If so, how can I make that?

YARDを使用してコードをドキュメント化し、たとえば@overloadタグを使用し、他の誰かが私のgemをインストールして、RDocを使用してドキュメントを生成した場合、結果は乱雑になりませんか？

これに対処する良い方法はありますか？

私が取り組んでいる次のJavascriptライブラリ用の素晴らしいJavascriptドキュメントジェネレータが本当に必要です。明らかに、人々がそれを理解するために、私は私の図書館の文書が必要です。ドキュメントに適したライブラリを見つけるのに苦労しています。さまざまなプロジェクトを調べましたが、それらは私が必要としているものではありません。

JavascriptでRubydoc.infoまたはYARDスタイルのドキュメントを作成するJavascript用の優れたドキュメントジェネレータはありますか？ありがとう。