問題タブ [doxygen]

Doxygen 用の Lingo フィルターを知っている、または持っている人はいますか?

DocMaker で遊んだことがありますが、director への依存関係が生じ、Doxygen のように柔軟でもフル機能でもありません。

-マーティ

私はかなり大きなオープン ソース RTS ゲーム エンジン ( Spring ) に取り組んでいます。私は最近、Lua で呼び出し可能な新しい C++ 関数を追加しました。それらをどのように文書化するのが最善かを考えています。同時に、多くの既存の Lua 呼び出しに関する文書を作成/更新するよう人々を刺激します。

したがって、ドキュメントを最初に C++ 関数の近くに doxygen コメントとして記述できればよいと考えました。これは、関数の本体が明らかに関数の動作を正確に定義しているため簡単です。ただし、一般的に git (私たちが使用する VCS) や C++ についてほとんど理解していない、エンジンを使用するゲーム開発者によってドキュメントが改善されることを望みます。

したがって、C++ ファイルから apidoc を自動的に生成する方法があれば理想的ですが、より幅広い視聴者がコメントを更新したり、例を追加したりできるようにする wiki のような Web インターフェイスも必要です。

だから私は、doxygen スタイルの書式設定、それらのコメントの wiki のような編集 (ソース ファイルの他の部分の編集を許可しないことが望ましい) と git を統合する Web ツールが存在するかどうか疑問に思っています。(Web インターフェイスを介して変更されたコメントを特別なブランチにコミットするため)

私たち開発者は、このブランチを時々マージして、マスター ブランチに改善を追加することができます。同時に、開発者によるドキュメントの改善は、マスター ブランチをこの特別なブランチにマージするだけで、この Web ツールに反映されます。ブランチ。

私はまだ何も見つけていません。この特定のものがまだ存在するのではないかと疑っていますので、どんな提案も大歓迎です!

この質問に関連して、単一のdoxygenコメントをHTMLに変換するJavaScriptコードスニペット/ライブラリを誰かが知っているかどうか疑問に思っていましたか?

例えば、

次のように変換されます。

doxygen の他のすべてのフォーマット関連タグについても同様です。

私はすでにこれを見つけました。自分で実装する必要がある場合、これは良い出発点のようですが、おそらく完全なプロジェクトがありません:-)

だから、提案は大歓迎です！

私は .cpp ファイルを持っていますが、Doxygen は次の形式を含む関数を文書化できないことがわかりました:

およびは例外処理メカニズムであり、問​​題を引き起こしますEH_Start。EH_Stop

どうすればそれらを除外できますか?

バックグラウンド：

Objective-C で複合辞書データ構造の階層を作成し、NSMutableDictionaryから継承しているため、NSDictionary/NSMutableDictionary が呼び出されるあらゆる場所でこれらのクラスを使用できます。(人々が私が車輪を再発明していると思わないように、それぞれがCFMutableDictionaryRefを使用し、さらにキーをソート順、挿入順などで格納する追加の構造を使用します。) Apple のドキュメントに従って、私はこれらのクラスの他のすべてのメソッドが使用する必要なNSDictionary プリミティブとNSMutableDictionary プリミティブ。

ゴール：

私は自分のフレームワークの API をできるだけ完全に文書化するよう努めているので、 (Doxygen によって生成された)カスタム サブクラスの文書化に NS(Mutable)Dictionary の最も一般的なメソッドの説明を含めてほしいと思います。特定のカスタム ディクショナリが変更されずに継承するメソッドだけを別のページで確認する必要があります。さらに、メソッドの実装は NS(Mutable)Dictionary から変更されていませんが、オーバーライドされたプリミティブ メソッドによって引き起こされるさまざまな機能をドキュメントに反映する必要がある場合があります。

問題：

オーバーライドされたメソッドのみが文書化されている場合、エラー/警告は表示されません。継承されたメソッドを文書化するコメントを追加すると、ヘッダー ファイルにメソッド プロトタイプを追加しない限り、Doxygen は文句を言います (その文書を作成しません)。プロトタイプを追加すると、宣言されたメソッドのメソッド定義が含まれていないため、コンパイラは実装が完了したという警告を発行します。明らかに、これはメソッドが親クラスに存在する場合ですが、プロトタイプがサブクラスで本質的に再宣言されているため、コンパイラはその実装に固執しています。

質問:

• 親クラスから継承されたメソッドの「'X' のメソッド定義が見つかりません」という警告を Xcode/gcc で抑制させることは可能ですか?
• デラレーションが存在しないメソッドのドキュメントを作成するように Doxygen に強制することは可能ですか? \fnコマンドを使用しようとしましたが、同じ結果が得られました。
• 私が書いたドキュメントが実際に NSMutableDictionary に適用されると Doxygen を騙して、それをすべてのカスタム サブクラスに表示させることは可能ですか?

編集：

私が知る限り、最初の質問に対する答えはイエスでもありノーでもあります。技術的には、-Wno-protocolオプションを使用する(または Xcode ビルド設定で「不完全な Objective-C プロトコル」警告をオフにする)と、GCC は、すべてのプロトコル メソッドを実装していないように見えるクラスに関するコンパイル時の警告を抑制します。ただし、これにより、必要なすべてのメソッドを実際に実装していないクラスの問題が隠されます。プロトコルを多用するフレームワークを構築する場合、それは実際にはオプションではありません。現在、GCC は、リンクされた (ソースではない) 親クラスから継承されたメソッドを認識していないようです。

職場で Doxygen を使用していますが、Java コードに問題があります。EXTRACT_ALL=NO、EXTRACT_PRIVATE=NO、EXTRACT_STATIC=NO、EXTRACT_LOCAL_CLASSES=NO、および EXTRACT_LOCAL_METHODS=NO を使用すると、パブリックまたはプライベートとして定義されていない静的メンバーが出力に含まれます。

元。次のコードがあるとします。

func3staticは、パッケージ レベルの関数であるという理由だけで定義されています。

func1出力にfunc3表示され、表示したいだけですfunc1。

public として明示的に定義された関数のみを表示する方法を知っている人はいますか?

前もって感謝します。

私はc++/ cliライブラリが主にac＃アプリケーションから使用されているプロジェクトに取り組んでいます。

Visual Studio内のc＃インテリセンスにc ++ / cliのコードコメントを表示する方法はありますか？

ない場合、c＃から（そしてもちろんc ++ / cli内で）簡単に使用できるようにc ++ / cliコードを文書化するための最良の方法は何でしょうか？XMLコメントvsdoxygenvs他のツール（どちら）についてどう思いますか？

AtomineerUtilsアドイン（Visual Studioがdoxygenコメントブロックを自動入力できるようにする）を評価しています。

__declspec（dllexport）を含むクラス定義があると、わずかに失火します。つまり、追加するコメントブロックに表示されるクラス名の代わりに、declspecという単語を使用します。

小さな煩わしさですが、それでも迷惑です。

誰かがこのツールを使用して、何か手がかりがありますか？

xrefitem を使用して「関連ページ」を作成しようとしていますが、機能していないようで、インラインでもないようです。次に例を示します。

Doxygen 1.5.9 を使用しています。これらはどちらも関連ページには表示されません。コメントも CPP ファイルに含めています。

doxygen では、実装ファイル内に object-c カテゴリを作成して、一般にアクセスしてはならないインターフェイスを非表示にすることができます。ただし、doxygen は、メンバーが「パブリック」であるとしてカテゴリをまだ文書化しています。\protected または \private を追加しても、これは変わりません。

これをそのカテゴリの「プライベートメソッド」セクションに入れる、またはさらに良いことに、パブリッククラスがプライベートとしてのみリストされている同じドキュメントに配置する、私が見落としている別のメソッドはありますか?

これが私の設定の一部です：