私は Doxygen に、C に似た言語 (PARI/GP) で書かれたコードを文書化してもらいたいのですが、構文が少し異なります。私は、Doxygen が存在しないエンティティを文書化できると信じています。プログラミング言語が Doxygen でサポートされていない場合、これが最も簡単な方法のようです。私はこのようなものが欲しい:
/*!
\fn foo(param,{option})
\brief some brief description here
\param[in](param) mandatory parameter description
\param[in](option) optional parameter description
*/
/*! \cond DOXYGEN_SHOULD_SKIP_THIS */
foo(param, {option}) =
{
...
};
addhelp(foo, "help message for `foo` function");
/*! \endcond */
残念ながら、Doxygen は「ドキュメント化されたシンボル 'foo' は宣言または定義されていません」という警告を生成foo
し、出力 HTML に をリストしません。コードではなくドキュメンテーション ブロックのみを使用して、Doxygen に適切な HTML を強制的に生成させる方法はありますか?