doc_inner/README

   1 このファイルは、YACASL2のdoc_innerディレクトリーに関するREADMEファイルです。
   2
   3 doc_innerディレクトリーには、YACASL2の内部仕様書が格納されます。
   4 YACASL2の内部仕様書は、DoxygenとGNU GLOBALの2種類があり、
   5 どちらもこのディレクトリーでmakeを実行することで生成できます。
   6
   7 DoxygenやGNU GLOBALがインストールされていないシステムでは、
   8 makeを実行しても内部仕様書は生成されません。
   9
  10 ■Doxygen
  11 Doxygenについては、下記URLを参照してください。
  12 http://www.doxygen.jp/
  13
  14 doc_inner/doxygenディレクトリーに、GNU Globalのdoxygenコマンドで
  15 生成されるHTMLドキュメントが格納されます。
  16
  17 YACASL2でのDoxygenの設定ファイルは、YACASL2の
  18 ルートディレクトリーにある「../Doxyfile」です。
  19
  20 ■GNU GLOBAL
  21 GNU GLOBALについては、下記URLを参照してください。
  22 http://www.gnu.org/software/global/
  23
  24 doc_inner/gnu_globalディレクトリーに、GNU Globalの
  25 htagsコマンドで生成されるHTMLドキュメントが格納されます。
  26
  27 GNU Globalのgtagsコマンドで生成されるGTAGS、GRTAGS、GRPATHは、
  28 YACASL2のルートディレクトリー（..）に生成されます。
  29
  30 ■内部仕様書の生成方法
  31 ▼DoxygenとGNU Globalの両方を生成
  32 次のどちらか
  33 $ make
  34 $ make all
  35
  36 ▼Doxygen
  37 $ make doxygen
  38
  39 ▼GNU Global
  40 $ make gnu_global