generate_specification.sh

   1 #!/bin/bash
   2
   3 LATEX_PATH=`pwd`/doc_generated/latex
   4 PDF_PATH=`pwd`/doc_generated
   5 PDF_NAME=IVI_LayerManagement_Design_v3_0_MG0001
   6
   7
   8 #==============================================================================
   9 echo "running doxygen..."
  10 #==============================================================================
  11 doxygen
  12
  13 #==============================================================================
  14 echo "patching latex main document..."
  15 #==============================================================================
  16 # doxygen will generate more sections of the document
  17 # than neccessary for the specififcation document.
  18 # This processing step removes the unneccessary sections
  19 # from the main latex file, so they won't be included in
  20 # the resulting PDF file.
  21
  22 MAIN_PAGE=`cat $LATEX_PATH/refman.tex`
  23 echo "$MAIN_PAGE" \
  24     | grep -Ev "{struct|{class" \
  25     | grep -Ev "printindex" \
  26     | grep -Ev "{action}|{LayerManagement Command Action Overview}" \
  27     | grep -Ev "{frequency}|{LayerManagement Command Frequency Overview}" \
  28     | grep -Ev "{Class Documentation}" \
  29 > $LATEX_PATH/refman.tex
  30
  31
  32 #==============================================================================
  33 echo "creating PDF from latex documentation..."
  34 #==============================================================================
  35 cd $LATEX_PATH
  36 make 1> /dev/null
  37 cd -
  38
  39
  40 #==============================================================================
  41 echo "applying name to PDF document..."
  42 #==============================================================================
  43 cp $LATEX_PATH/refman.pdf $PDF_PATH/$PDF_NAME.pdf
  44
  45
  46 #==============================================================================
  47 echo "The LayerManagement specification was stored here:"
  48 #==============================================================================
  49 echo "$PDF_PATH/$PDF_NAME.pdf"
  50