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 ==========
  12
  13 Doxygenについては、下記URLを参照してください。
  14 http://www.doxygen.jp/
  15
  16 doc_inner/doxygenディレクトリーに、GNU Globalのdoxygenコマンドで
  17 生成されるHTMLドキュメントが格納されます。
  18
  19 YACASL2でのDoxygenの設定ファイルは、YACASL2の
  20 ルートディレクトリーにある「../Doxyfile」です。
  21
  22 GNU GLOBAL
  23 ============
  24
  25 GNU GLOBALについては、下記URLを参照してください。
  26 http://www.gnu.org/software/global/
  27
  28 doc_inner/gnu_globalディレクトリーに、GNU Globalの
  29 htagsコマンドで生成されるHTMLドキュメントが格納されます。
  30
  31 GNU Globalのgtagsコマンドで生成されるGTAGS、GRTAGS、GRPATHは、
  32 YACASL2のルートディレクトリー（..）に生成されます。
  33
  34 内部仕様書の生成方法
  35 ====================
  36
  37 DoxygenとGNU Global両方の内部仕様書を生成
  38 ********************************************
  39
  40 次のどちらか
  41 $ make
  42 $ make all
  43
  44 Doxygen内部仕様書を生成
  45 *************************
  46
  47 $ make doxygen
  48
  49 GNU Global内部仕様書を生成
  50 ***************************
  51
  52 $ make gnu_global