test
A Main page

ここに簡単な説明が入ります. このページは研究結果をまとめるためのにdoxygenを乱用するための 使い方をまとめたものです.

研究結果をまとめるときによく使いそうなコマンドが以下にまとめられています. もし,面白い情報やより,説明がわかりやすくなりそうなコマンドが あったら,順次追加していく予定です.


doxygenの書き方

doxygenに文章を追加する方法はソースコードにコメントを書く方法以外に 文章を表すdoxという拡張子を使用します. また,doxの中身はdoxygenのコメントから文章を作成するという特性上, すべてコメントアウトされていなければなりません. 何を行っているかわからないかもしれませんが, 要は,example.doxというファイルがあったとして,その中身は

1 /**
2 
3 自由にリンク,ページ名を設定
4 \page link_example example
5 
6 ここに自由に文章を記述
7 
8  */

としなければならないということです. ページとはhtmlにコンパイルした時の実際のページのことです. 1つのmainpageとその他複数のpageから成り立っています. リンクとは,doxygenでは各ページや各セクションにURLが付与され,ページ内リンクを 作成することが可能で,そのときにURLの代わりに使用されるユーザー定義の文字列のことです..


概要

TOC Table of Contents. つまり目次が作られます.

1 [TOC]
Author
Harumo Sasatake
1 \author Harumo Sasatake
Version
1.0
1 \version version num
Date
2017-8-16
1 \date 2017-*-**
1 \copyright ***

セクション

sectionコマンドにより,文章内を章,節などに分類することができます. 大きさはsubsubsectionまで使用できます.

Section1

\section s1 Section1

s1はページ内リンクを貼るときのURLとして使えます. そのため,同じものが2つあってはいけません. Section1へのリンクはこんな感じです Section1は章のタイトルです.自由に付けましょう.

Subsection2

\subsection <section name> (section title)

Subsubsection3

\subsubsection <section name> (section title)

リンク

ページ内リンク

sectionコマンドの<section name>をURLのように使用して ページ内リンクを貼ることができます.

Section1へのリンクはこんな感じです

[Section1へのリンクはこんな感じです](@ref s1)

ページ外リンク

普通のURLを使用して,そのページヘのリンクも貼ることが可能です.

doxygen.jp

[doxygen.jp](http://www.doxygen.jp/)

特殊な表現

誇張表現

Attention
注意すべきリスト
Warning
警告
Note
注意事項
Todo:
TODO Related PagesにTODO Listが自動的に作られます
Precondition
前提条件
Postcondition
事後条件
Bug:
バグ Related PagesにBUG Listが自動的に作られます

内容に関する表現

A paragraph title
これは段落です.この段落は空行もしくは, 他のセクションの導入コマンドで終了します.
1 \par (paragraph title)
Remarks
これは注釈です.この注釈を記述するための段落は, 空行,もしくは他のセクションの導入コマンドで終了します.
1 \remarks

フォント

  • Italic
  • Bold
  • Type writer font (expressing code)
1 \li \a Italic
2 \li \b Bold
3 \li \c Type_writer_font

list<doxygen version | Nest is not available>

  • リスト表示1
  • リスト表示2
  • リスト表示3
1 \li リスト表示1
2 \li リスト表示2
3 \li リスト表示3

その他の表現

ソースコードのシンタックスハイライト

int main(void);

(円マーク)code{.cpp}
int main(void);
(円マーク)endcode
円マークのところをエンターキーの上にある円マークにしてください. もしくは,mainpage.dox内をご覧ください.

Graphviz

プラント図やクラス図も簡単にかつ,綺麗に書くことができます.

dot_inline_dotgraph_1.png
1 \dot
2 digraph example {
3  node [shape=record, fontsize=10];
4  b [ label="class B"];
5  c [ label="class C"];
6  b -> c [arrowhead="open", style="dashed"];
7 }
8 \enddot

数式

  1. インライン数式

    $(x_1,y_1)$$(x_2,y_2)$ の間の距離は $\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}$

  2. 中央揃えの番号なし数式

    \[ |I_2|=\left| \int_{0}^T \psi(t) \left\{ u(a,t)- \int_{\gamma(t)}^a \frac{d\theta}{k(\theta,t)} \int_{a}^\theta c(\xi)u_t(\xi,t)\,d\xi \right\} dt \right| \]

  3. latexコマンドを使用しての数式

    \begin{eqnarray*} g &=& \frac{Gm_2}{r^2} \\ &=& \frac{(6.673 \times 10^{-11}\,\mbox{m}^3\,\mbox{kg}^{-1}\, \mbox{s}^{-2})(5.9736 \times 10^{24}\,\mbox{kg})}{(6371.01\,\mbox{km})^2} \\ &=& 9.82066032\,\mbox{m/s}^2 \end{eqnarray*}


マークダウン

マークダウンも使用できます.

見出し

ヘッダにラベル付をすることができます.

h1

#h1 {#head1}

{head1}はsectionでいうsection nameでページ内リンクを貼るときにURLのように 参照できます.

h2

## h2

通常のマークダウンと同じように{head2}なしでも使用できます.ただ,この場合はこの章に対する ページ内リンクは作成できません.

h3

h4

h5

リンク

webサイトへのリンクも,インラインリンクも,相対パスによる PC内部のhtmlへのリンクも可能です.

H1

1 [H1](#head1)

リスト表示<markdown version Nest is available>

  • list1
    • list1.1
  • list2
  • list3
    • list3.1
      • list3.2
        • list3.3
  1. first
  2. second
  3. third

引用

quate
quate
quate

Code

バッククオートではなくチルダによりコードブロックを作成します.

int main(void)

水平線


---

HTML

ドキュメント内でHTMLタグを使用することも可能です. 詳しくはここを見てください.

また,htmlonlyコマンドを使用すると,作成されるhtmlにhtmlコードを埋め込む ことが可能です.doxygenのバージョンにもよりますがhtml5に対応しています.

70 %

1 \htmlonly
2 <progress value="70" max="100">70 %</progress>
3 \endhtmlonly

編集に際して

Type the following command, when dox file is edited.

The command makes doxygen command is run every 10 sec.

1 watch -n 10 doxygen Doxyfile

extra css

表示をかっこ良くするためにお好みのCSSを使用することができます. CSSは先人がいくつか作っているので,それをダウンロードしましょう. このページで試用しているCSSは以下のgithubからダウンロードしてきたものです.

doxygen-theme

Doxyfileのある場所に

  • customdoxygen.css
  • DoxygenLayout.xml

をコピーしましょう.

そして,Doxyfileの

  • HTML_EXTRA_STYLESHEET =
  • LAYOUT_FILE =

の項目に先ほどコピーしたファイルを設定しましょう

  • HTML_EXTRA_STYLESHEET = ./customdoxygen.css
  • LAYOUT_FILE = ./DoxygenLayout.xml

最後に

1 doxygen Doxyfile

として,コマンドを走らせると CSSが適用されたものが出来上がります.