scripts/helpers/doxygen.sh

   1 #!/usr/bin/env bash
   2
   3 #
   4 # Copyright (c) 2020 Project CHIP Authors
   5 #
   6 # Licensed under the Apache License, Version 2.0 (the "License");
   7 # you may not use this file except in compliance with the License.
   8 # You may obtain a copy of the License at
   9 #
  10 #     http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 # See the License for the specific language governing permissions and
  16 # limitations under the License.
  17 #
  18
  19 CHIP_ROOT="$(dirname "$0")/../.."
  20 CHIP_NAME="Connected Home over IP"
  21 CHIP_VERSION="$(git rev-parse --short HEAD)"
  22
  23 die() {
  24     echo " *** ERROR: $*"
  25     exit 1
  26 }
  27
  28 install_doxygen() {
  29     if ! doxygen --version >/dev/null 2>&1; then
  30         echo "doxygen not installed. Installing..."
  31         case "$(uname)" in
  32             "Darwin")
  33                 brew install doxygen
  34                 ;;
  35             "Linux")
  36                 sudo apt-get update
  37                 sudo apt-get install -y doxygen
  38                 ;;
  39             *)
  40                 die
  41                 ;;
  42         esac
  43     fi
  44 }
  45
  46 install_graphviz() {
  47     if ! dot -V >/dev/null 2>&1; then
  48         echo "graphviz not installed. Installing..."
  49         case "$(uname)" in
  50             "Darwin")
  51                 brew install graphviz
  52                 ;;
  53             "Linux")
  54                 sudo apt-get update
  55                 sudo apt-get install -y graphviz
  56                 ;;
  57             *)
  58                 die
  59                 ;;
  60         esac
  61     fi
  62 }
  63
  64 install_doxygen
  65 install_graphviz
  66
  67 cd "$CHIP_ROOT" || exit 1
  68
  69 CHIP_NAME=$CHIP_NAME CHIP_VERSION=$CHIP_VERSION doxygen docs/Doxyfile || die "doxygen failed"
  70
  71 exit 0