問題タブ [doxygen]

質問：Doxygenを使用してRubyコードを文書化するにはどうすればよいですか？

免責事項：rubyにはすでにドキュメント用のシステムが組み込まれており、おそらく他の方法もありますが、私が操作している特定の制約は、Doxygenにその仕事をさせる方法です（それが可能であると仮定します）。

私が現在所属しているソフトウェア グループは、最近、コードベースのドキュメント化を開始することを決定しました。彼らが採用している最初のアプローチは、組み込みのトリプル スラッシュ /// の文書化方法を使用することでした。

私たちが発見し始めた新しい問題は、doxygen を介してこれを実行した結果が、コードベースの非常に適切な表現であるということでした。タスクが正確に何をしているのかを尋ねます。

/// メソッドと doxygen を使用してコードを文書化する簡単な方法はありますか?特定の方法で実行すると、システム エンジニアリング バージョンの文書だけを含む文書を生成できます。メソッドやメンバー変数など、システム担当者を怖がらせる標準的なプログラマー向けドキュメントはありますか? 代替ソリューションの提案も大歓迎です。

これが私たちが達成しようとしていることについて少し混乱している場合は申し訳ありませんが、回答が得られたら調整できます. ありがとう.

私は、さまざまな言語で何年も使用してきたdoxygenの大ファンです。特に、画像を含め、Graphviz ドット ジェネレーターを実行して、インライン DOT コードまたは外部ファイルから任意のインライン ダイアグラムを作成できる wiki のような機能を高く評価しています。

RDocには、Graphviz を使用してクラス図を生成するためのダイアグラム サポートがありますが、任意の画像や図を含める方法がわかりません。また、酸素のような任意のページの構築もサポートしていないようです。

これらの Doxygen スタイルの機能を Ruby に提供するツールはありますか?

ツールのRuby Toolboxリストをざっと調べたところ、それらはすべてRDocのバリアントのようです。

現時点で私にとって最も可能性の高い解決策は、Yard を拡張することです。

正確に言うと、宣言の時点で列挙型をdoxする方法を知っているので、代わりにそれらをアウトオブラインでdoxしたいと思います。

ヘッダーファイルにdoxygenコメントがないようにしたい。それらはすべて.cppファイルにあります。これは、関数、クラス、typedefなどでは問題になりません。enum次のようにそれ自体を文書化することもできます。

しかし、どうすればそこの価値を文書化できenumますか？

ありがとう！

現在、次のエラーメッセージが表示されます。

コード内の単一のタグを探してみました@f$が、これまで原因を突き止めることができませんでした。この特定の問題を解決するにはどうすればよいですか?

さらに、doxygen でラテックス エラーをデバッグするための一般的なヒントを教えてください。ログファイルはどこかにありますか?

Delphi 用の Modelmaker に似たものを探しています。モジュールの依存関係を表示します。どんな助けでも大歓迎です。

Doxygenはこれまでのところ素晴らしいです。Doxygenで私が望むことを達成できるかどうか誰かが知っているなら、私に知らせてください:)

Apple Core Library docset のように見え、動作する API 用の docset を作成したいと考えています。たとえば、NSString のページを見てください。

Doxygen と headerdoc2html を試しました。どちらも私が望むものに非常に近いものではありません。

headerdoc によって生成されたファイルには、Apple ファイルにある上位レベルの構造がほとんどなく、グラフィック デザインも異なります。特定のメソッドを見るときのように、より詳細なレベルでは、物事はより近くなりますが、すべての詳細な構造を持っているわけではありません。

Doxygen によって生成されたファイルは、非常に異なるグラフィック デザインを持つことは言うまでもなく、非常に異なる高レベル構造を持っています。

他に何を試す必要がありますか？または、これらのツールのいずれかに、より近いものを提供するパラメーターはありますか?

ありがとう、パット