changeset 407:5f3d7c23ffa7 prerelease

doxygen places xml and html docs in Documentation folder. setup_board.sh runs doxygen
author Liam Donovan <l.b.donovan@qmul.ac.uk>
date Wed, 15 Jun 2016 12:23:29 +0100
parents f5fcd50a6f8d
children f92afe6018d7
files Doxyfile scripts/setup_board.sh
diffstat 2 files changed, 5 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/Doxyfile	Wed Jun 15 12:01:47 2016 +0100
+++ b/Doxyfile	Wed Jun 15 12:23:29 2016 +0100
@@ -52,7 +52,7 @@
 # If a relative path is entered, it will be relative to the location
 # where doxygen was started. If left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       =
+OUTPUT_DIRECTORY       = Documentation
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
 # 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -1380,7 +1380,7 @@
 # generate an XML file that captures the structure of
 # the code including all documentation.
 
-GENERATE_XML           = NO
+GENERATE_XML           = YES
 
 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
--- a/scripts/setup_board.sh	Wed Jun 15 12:01:47 2016 +0100
+++ b/scripts/setup_board.sh	Wed Jun 15 12:23:29 2016 +0100
@@ -59,6 +59,9 @@
   echo "Creating directory structure on BeagleBone..."
   ssh $BBB_ADDRESS "mkdir -p $BBB_BELA_HOME/build ; mkdir -p $BBB_BELA_HOME/build/core ; mkdir -p $BBB_BELA_HOME/build/projects; mkdir -p $BBB_BELA_HOME/projects" &&\
   echo "Done."
+  echo "Creating on-board documentation..."
+  ssh $BBB_ADDRESS "cd $BBB_BELA_HOME; doxygen" &&\
+  echo "Done."
 else
   echo "Aborting..."
   exit