タグ

doxygenに関するtakashi001のブックマーク (6)

  • Doxygen マニュアル

    Doxygen マニュアル このマニュアルは 3つのパートに分かれています。 それぞれのパートは、さらにいくつかのセクションに分かれます。 パート 1 は、ユーザー・マニュアルです。 セクション インストール では、 ダウンロード、コンパイル、 インストールの方法を説明します。 セクション はじめよう では、最初のドキュメントを素早く生成する方法を説明します。 セクション コードのドキュメント付け では、コードにドキュメントを付けるための様々な方法を例示します。 セクション リスト では、リストを作成する様々な方法を示します。 セクション グループ化 では、グループ化の方法を示します。 セクション 式のインクルード では、ドキュメントに式を挿入する方法を示します。 セクション グラフと図 では、Doxygen で生成できる図とグラフを説明します。 セクション プリプロセス では、Doxyg

  • Doxygenで生成されるドキュメントにC言語のマクロ定義が出てこないことがあるのを調査 - Qiita

    PS > doxygen.exe -V 1.9.2 (caa4e3de211fbbef2c3adf58a6bd4c86d0eb7cb8) with clang support 5.0.0. 現象 test.h はドキュメント生成するつもりのないファイル。 ただし、以下のようにコメント文に Markdown のコードブロックの開始に該当する記述がある。

    Doxygenで生成されるドキュメントにC言語のマクロ定義が出てこないことがあるのを調査 - Qiita
  • Markdown記法 チートシート

    Markdown記法のチートシートです。 記法はGitHub Flavored Markdownに準拠し、一部拡張しています。 Qiitaでシンタックスハイライト可能な言語一覧については、 シンタックスハイライト可能な言語 をご覧下さい。 Code - コードの挿入 Code blocks - コードブロック たとえば、「Ruby」で記述したコードをファイル名「qiita.rb」として投稿したいときは、 バッククオート(`) か チルダ(~) を使用して以下のように投稿するとシンタックスハイライトが適用されます。 コードブロック内でコードブロックを書きたい場合は異なる記号を使うことで書けます。

    Markdown記法 チートシート
  • 感激!? Doxygenで文書作成(研究・開発用) - Qiita

    前文 Doxygenというドキュメントジェネレーターが世の中にはある. 作成済みライブラリのコメントから,ドキュメントを勝手に,かついい感じに作成してくれるツールである. 多くのライブラリではこのツールを,公式が言っているとおりにドキュメント生成ツールとして使用してきた. しかし,そうであろうか.果たして,当にDoxygenはドキュメント生成ツールなのであろうか. 何事も疑ってみることが肝心ではなかったか. セリヌンティウスはメロスを疑って 「えっ? 身代わり? いやいや,だって,君,帰ってこないじゃん.」 「ていうか,君に妹なんていたっけ?」 「帰ってこなかったら,俺,死刑じゃん.俺の首が飛んじゃうよ?!」 「俺の首,まあまあ,飛ぶよ? となり町ぐらいまでなら飛んじゃうよ?」 などという対応をすべきでなかったか. まあ,このような塩対応をすることにより,メロスは死刑.走れメロスの物語は

    感激!? Doxygenで文書作成(研究・開発用) - Qiita
  • Doxygen:コードのドキュメント付け

    コードのドキュメント付け 特殊ドキュメント・ブロック 特殊ドキュメント・ブロックは、C または C++スタイルのコメントブロックにマークを付け加えたもので、Doxygenはこれをドキュメント断片と認識して、ドキュメントを生成します。 PythonとVHDLコードについては、別のコメント表記規則があります。セクションPython での特殊ドキュメント・ブロック と VHDL での特殊ドキュメント・ブロック で説明します。 各コード要素について、説明形式が2(3の場合も)種類あり、これらがドキュメントを形成します。それは、要約説明と 詳細説明で、どちらもオプションです。メソッドと関数については、もうひとつの形式があり、いわゆる"文内"説明で、メソッドや関数の体内のコメントブロックの連結からなります。 ひとつ以上の要約説明または詳細説明を指定できます。(ただし、出現順序が指定されていないため

    takashi001
    takashi001 2016/05/30
    書き方
  • Loading...

  • 1