README.doxygen

   1  Documentation for generating doxygen documentation\r
   2 ---------------------------------------------------------\r
   3 \r
   4 1. Options for gendox\r
   5 More up-to-date command line options are available via\r
   6 the command ./gendox --help\r
   7 \r
   8 usage: "sh gendox [ <target(s)> ] [ -o <output_dir> ]"\r
   9     or "./gendox [ <target(s)> ] [ -o <output_dir> ]"\r
  10 \r
  11 <target(s)> \r
  12   The directory, or directories to generate the \r
  13   documentation from.\r
  14 \r
  15 -o\r
  16   Specifies the output directory <output_dir> which\r
  17   should follow the -o switch\r
  18   \r
  19 -q --quiet\r
  20   Stops the script from outputing status information,\r
  21   other than errors.\r
  22   \r
  23 -k --kill\r
  24   Kills other running doxygen pids.\r
  25 \r
  26 eg: ./gendox include/ -o ../Documentation\r
  27 \r
  28 * This will produce documentation for the include files,\r
  29 and output to the directory specified one level above the\r
  30 current directory.\r
  31 \r
  32 The target can be the current directory "./" in which case\r
  33 doxygen will generate documentation for all subdirectories\r
  34 of the current directory recursively.\r
  35 \r
  36 The default output directory is currently ...\r
  37 > ../GtkRadiant-doxygen\r
  38 \r
  39 * If the script is called without any target directories\r
  40 it will generate documentation for the core of radiant...\r
  41 include/ libs/ radiant/ and plugins/\r
  42 \r
  43 If there are specific options that you'd like to customise,\r
  44 the DoxyConfig file is used to generate the file from which\r
  45 doxygen gets its settings from. So any changes that need\r
  46 to be made should be made to this file.\r
  47 \r
  48 \r
  49 Gef :]\r
  50 (gefdavis@dingoblue.net.au)\r
  51 ---------------------------------------------------------\r