c++ - 偽のクラスの文書化

Question

必要なすべての C++ 関数を Lua に公開する関数があります。「スクリプト API」のさまざまな側面を表すさまざまなテーブルがあります。これらのスクリプトを公開する C++ コードを使用して、doxygen を使用してスクリプト参照を作成します。機能。

関数の本体に「偽の」クラスを作成しようとしましたが、これにより、指定した名前の新しいエントリが正常に作成されました。たとえば、いくつかの関数が公開されている「Math」という名前のテーブルを作成した場合、どのようにこの「偽の」クラスで「偽の」メンバー関数も作成しますか?関数を定義する \fn を単純に渡そうとしましたが、実際には説明を追加する実際のメンバーではないため、表示されません。すべてのクラスの逐語的な定義を手動で修正せずに、doxygen でこの種の効果を作成するにはどうすればよいですか?代わりに、コメント ブロックを実際のメンバーを持つ実際のクラスであるかのように扱いますか?

Answer 1

Lua コードを C++ であるかのように文書化しようとしているようです。可能かもしれませんが、それは価値があるよりもおそらく面倒です。

doxygen を使用して Lua コードを文書化しようとしている場合は、doxygen-luaを試すことができます。

Lua API が小さい場合は、関連する C++ コードへの \ref を使用して、手動でページを作成するだけで済みます。（ハックですが、私は以前にこれをやったことがあります。）

LuaDocなどの Lua API 用の他のドキュメント ジェネレーター、または lua-users wiki DocumentingLuaCodeにリストされている他のものを使用することも検討できます。

Answer 2

lua 値に似た型名を持つ偽の .doxy ファイルを作成することになりました。どうやら doxygen は、それにスローされる型を文書化します。