documentation/build.scons

   1 # Copyright 2008, Google Inc.
   2 # All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are
   6 # met:
   7 #
   8 #     * Redistributions of source code must retain the above copyright
   9 # notice, this list of conditions and the following disclaimer.
  10 #     * Redistributions in binary form must reproduce the above
  11 # copyright notice, this list of conditions and the following disclaimer
  12 # in the documentation and/or other materials provided with the
  13 # distribution.
  14 #     * Neither the name of Google Inc. nor the names of its
  15 # contributors may be used to endorse or promote products derived from
  16 # this software without specific prior written permission.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30
  31 Import('env')
  32
  33 env.SetDefault(DOXYGEN=ARGUMENTS.get('DOXYGEN', 'doxygen'))
  34
  35 # Gate on host platform rather than target, since all are supported.
  36 if env['PLATFORM'] in ['win32', 'cygwin']:
  37   env['ENV']['NACL_SDK_PLATFORM'] = 'windows'
  38 elif env['PLATFORM'] in ['darwin']:
  39   env['ENV']['NACL_SDK_PLATFORM'] = 'mac'
  40 else:
  41   env['ENV']['NACL_SDK_PLATFORM'] = 'linux'
  42
  43 # The output is generated into scons-out/doc (c.f. Doxyfile).
  44 # Point your browser at  scons-out/doc/html/index.html
  45 node = env.Command(
  46     target='doxygen.log',
  47     source='Doxyfile',
  48     action='${DOXYGEN} documentation/Doxyfile 2>&1 > ${TARGET}')
  49 AlwaysBuild(node)
  50 Default(node)