問題タブ [yard]

「yard server -g」を実行していますが、axlsx の目次しか生成していません。

クラスをクリックすると、次のようになります。

理由はありますか？(Fwiw、他の gem は Yard サーバーで正常に動作しています)

Yard を実行してからファイル リンクをクリックすると、次のようになります。

助言がありますか？

.yardoptsファイルに次のようなカスタム タグをいくつか作成しました。

それらを Web ブラウザーで表示すると非常にきれいに表示されますが、クラスを表示しようとするとyri、カスタム タグが表示されません。

たとえば、このクラス

yri実行するとこのように表示されますyri Boring#index

yriカスタム タグを表示するように構成する方法はありますか?

定数を追加するDSLメソッドがあります（これはレガシーコードなので嫌いではありません）。これは正確なコードではありませんが、説明としては十分です。

定数を文書化し、Yard を使用AWESOMEしようとしています。タグLAMEがあればいいのにと思いましたが、ありません。@!constant

誰でもこれを手伝ってもらえますか？

YARD を使用していくつかの Ruby コードを文書化しましたが、トップレベルの名前空間のいくつかのメソッド用に作成した YARD 文書を yardoc の HTML 出力に表示するのに問題があります。

私のドキュメントは、lib/yard/globals.rb にある YARD gem のものと本質的に同じように見えますが、@apiタグが追加されています。私はそれを削除しようとしましたがyardoc、パラメーターなしで実行しまし--apiたが、問題は解決しませんでした。

これは例です:

yardocHTML ドキュメントを生成するために実行すると、最初はすべて問題ないように見えます。

ただし、生成された HTML には、私のドキュメントは含まれていません。pip-negotiate含まれているのは、 API タグを持つメソッドのリストだけです。ここで自分の目で確かめてください：

http://btw23.de/tmp/pip-negotiate/api/method_list.html

私が代わりに期待していたのは、トップレベルのメソッドに関する YARD 独自のドキュメントのようなものでした。

http://rubydoc.info/gems/yard/toplevel

私のyardoc呼び出しに欠けている特別な魔法はありますか？

私の yardoc バージョンは 0.8.6.2 で、Ruby 1.8.7 (2012-06-29 パッチレベル 370) [x86_64-linux] で動作します。

Yard でドキュメントを生成していますが、Ruby on Rails プロジェクトのサンプル ドキュメントが見つかりません。短い入門チュートリアルとruby​​doc.infoのいくつかの github プロジェクトしか見つかりませんでしたが、それらはまったく文書化されていません。Railsプロジェクトのコントローラー（アクション付き）、モデル、ルートを適切に文書化する方法を教えてください。

たとえば、私はそのようなコントローラを持っています:

そしてユーザーモデル：

Yard でドキュメントを生成していますが、 を実行yardoc --privateしても、ソース内のプライベート メソッドのドキュメントが表示されません。

なにが問題ですか？