プロジェクト開発ツールメモ

※上記の広告は60日以上更新のないWIKIに表示されています。更新することで広告が下部へ移動します。


BitTorrent



Doxygen

DOT

  • dot.exe
  • doxygen とは別にインストールする。
  • もともとはグラフ(相関図)を作成するツール。
  • これを組み込むと、include ファイルや関数の呼び出し相関図が追加できる。

コマンド起動

  • 最初、以下のコマンドで設定ファイル(Doxyfile)を作成する
 doxygen -g
  • Doxygen作成時
 doxygen <-f 設定ファイル>
  • -fオプションなしの場合は./Doxyfile が読み込まれる

設定ファイル

以下は変更、追加したほうが良い。
  • Project related configuration options
    • PROJECT_NAME, PROJECT_NUMBER
      • メインページの表紙に記述される
      • 例)
        • PROJECT_NAME = "AAA API Document"
        • PROJECT_NUMBER = "1.0.0"
    • FULL_PATH_NAMES
      • ソースをフルパスで表示する
      • デフォルトのYES→NOに変更(うざいから)
      • 例) FULL_PATH_NAMES = NO
    • OPTIMIZE_OUTPUT_FOR_C
      • C言語ならYESにしておく
  • Build related configuration options
    • EXTRACT_ALL
      • デフォルトのNO→YES
    • EXTRACT_PRIVATE
    • EXTRACT_STATIC
    • HIDE_SCOPE_NAMES
  • configuration options related to warning and progress messages
    • 特になし
  • configuration options related to the input files
    • INPUT
      • Doxygen対象フォルダ指定(複数可能)
      • 例) INPUT = "prjsrc" "include"
  • configuration options related to source browsing
    • SOURCE_BROWSER
      • YESにしておく
    • INLINE_SOURCES
      • YESにしておく
  • configuration options related to the alphabetical class index
    • ALPHABETICAL_INDEX
      • お好みでYESにしておく
  • configuration options related to the HTML output
    • GENERATE_TREEVIEW
      • これはYES
  • Configuration options related to the dot tool
    • HAVE_DOT
      • DOT使うのであればYES
    • CALL_GRAPH
      • 関連図を追加するならYES

Doxygenコメント記述方例

関数ヘッダ

 /*!
  * @brief      関数概要
  * 
  * @param[in]  inparam    説明
  * @param[out] outparam 説明
  * @param[in,out] inoutparam せつめい
  * @retval 0 正常終了
  * @retval 0以外 異常終了
  *
  * @note 関数説明詳細
  */                                                                              
  • @param, @retvalの引数名とか説明とかのインデントは出力時に自動調整してくれる

構造体(その1)

 /**
  * ~構造体
  */
 typedef struct _aaa {
     /**
      * @breif 変数簡易説明
      *
      * 詳細説明
      */
      int a;
 }

構造体(その2)

 /**
  * ~構造体
  */
 typedef struct _aaa {
      int a; //!< 簡易説明
      int b; //!< 簡易説明
 }
  • 「<」が直前の変数に対する説明であることを意味しているらしい


SubVersion(後で修正)


以下、TortoiseSVNでの操作

リポジトリの作成

  • リポジトリとして使用したいフォルダを用意し、右クリック→TortoiseSVN→ここにリポジトリを作成

インポート

  • 登録したいフォルダを「trunk」という名前で用意(通例)
  • trunk を右クリック→TortoiseSVN→インポート
  • リポジトリのURLでリポジトリを選択

キーワード置換


  • 右クリック→tortoisesvn→Settigs→Settigs画面→Gereral→edit→設定ファイルが立ち上がる
  • 以下の項目を設定(コメントアウト)
 [miscellany]
 enable-auto-props = yes
 
 [auto-props]
 *.txt = svn:mime-type='text/plain; charset=utf-8';svn:eol-style=native;svn:keywords='Id Rev Author Date'
 *.java = svn:mime-type='text/plain; charset=euc-jp';svn:eol-style=native;svn:keywords='Id Rev Author Date
 *.xls = svn:mime-type='application/octet-stream'
 *.jude = svn:mime-type='application/octet-stream'
  • auto-props 設定は拡張子ごとしかできない


Sphinx


ドキュメント整形ツール



最終更新:2010年12月02日 16:47
ツールボックス

下から選んでください:

新しいページを作成する
ヘルプ / FAQ もご覧ください。