Doc/README

   1 Root directory for OpenSG documentation
   2 =======================================
   3
   4 To generate the doxygen docs, go to your build directory (or create a new one [1]),
   5 run cmake in it and then call make Doc (or build the Doc target from your IDE).
   6 The documentation will be generated in the Doc subdirector of your *build* directory.
   7 You can pass the following variables to cmake to control the
   8 generated documentation:
   9
  10 OSG_DOXY_DOC_TYPE=User (Developer, Trac)
  11   Select the target audience for the documentation. The Developer setting
  12   will add details that are generally only of interest for extending
  13   OpenSG itself. The Trac setting is intended for integration of the
  14   documentation on the OpenSG Trac website, you probably don't want this mode [2].
  15
  16 OSG_DOXY_INPUTS=<FILE>
  17   Choose a file that contains the list of sources that doxygen scans.
  18   This is mainly useful when working on the documentation to reduce the
  19   size and build time of the docs.
  20
  21 OSG_DOXY_STDOUT_LOG=<FILE>
  22   Choose a file that will contain a log of the doxygen run.
  23   This is mainly useful when working on the documentation to be able to
  24   check for warnings reported by doxygen.
  25
  26
  27 See http://opensg.vrsource.org/trac/wiki/Dev/CodingStandard for information
  28 about how to add documentation to your favorite white spot on the OpenSG
  29 documentation map.
  30
  31
  32
  33 [1] Please the the OpenSG wiki for instructions on how to do this:
  34     http://opensg.vrsource.org/trac/wiki/Building
  35
  36 [2] It uses some extensions that haven't been accepted for the doxygen main
  37     branch yet. You need to download the sources and apply the aliasdiff patch in
  38     this directory in doxygen/src to make it work. Without this the aliases to link
  39     into the Wiki won't work, the rest will be fine.