Merge branch 'master' into add_notify

Author: shenghaoyang

.travis-ci.sh

@@ -143,10 +143,10 @@ elif [[ $TASK = 'codespell' ]]; then
       $SPELLINGBLACKLIST \
       \) | xargs")
   # count the number of codespell errors
-  spellingerrors=$(zrun codespell --check-filenames --quiet 2 --regex "[a-zA-Z0-9][\\-'a-zA-Z0-9]+[a-zA-Z0-9]" --exclude-file .codespellignore $spellingfiles 2>&1 | wc -l)
+  spellingerrors=$(zrun codespell --check-filenames --check-hidden --quiet 2 --regex "[a-zA-Z0-9][\\-'a-zA-Z0-9]+[a-zA-Z0-9]" --exclude-file .codespellignore $spellingfiles 2>&1 | wc -l)
   if [[ $spellingerrors -ne 0 ]]; then
     # print the output for info
-    zrun codespell --check-filenames --quiet 2 --regex "[a-zA-Z0-9][\\-'a-zA-Z0-9]+[a-zA-Z0-9]" --exclude-file .codespellignore $spellingfiles
+    zrun codespell --check-filenames --check-hidden --quiet 2 --regex "[a-zA-Z0-9][\\-'a-zA-Z0-9]+[a-zA-Z0-9]" --exclude-file .codespellignore $spellingfiles
     echo "Found $spellingerrors spelling errors via codespell"
     exit 1;
   else

.travis.yml

@@ -252,7 +252,7 @@ env:
    # -- BEGIN Coverity Scan ENV
    - COVERITY_SCAN_BUILD_COMMAND_PREPEND="cov-configure --comptype gcc --compiler gcc-4.9 --template && autoreconf -i && ./configure --enable-ja-rule --enable-e133"
    # The build command with all of the arguments that you would apply to a manual `cov-build`
-   # Usually this is the same as STANDARD_BUILD_COMMAND, exluding the automated test arguments
+   # Usually this is the same as STANDARD_BUILD_COMMAND, excluding the automated test arguments
    - COVERITY_SCAN_BUILD_COMMAND="make"
    # Name of the project
    - COVERITY_SCAN_PROJECT_NAME="$TRAVIS_REPO_SLUG"

Doxyfile

@@ -1199,7 +1199,7 @@ FORMULA_TRANSPARENT    = YES
 USE_MATHJAX            = NO
 
 # When MathJax is enabled you can set the default output format to be used for
-# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
+# the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
 # SVG. The default value is HTML-CSS, which is slower, but has the best
 # compatibility.
 

README

@@ -2,7 +2,7 @@
 
 [www.openlighting.org/ola](https://www.openlighting.org/ola)
 
-[![Build Status](https://travis-ci.org/OpenLightingProject/ola.svg?branch=master)](https://travis-ci.org/OpenLightingProject/ola) [![Coverity Scan Status](https://scan.coverity.com/projects/3514/badge.svg)](https://scan.coverity.com/projects/3514) [![Coverage Status](https://coveralls.io/repos/OpenLightingProject/ola/badge.png?branch=master)](https://coveralls.io/r/OpenLightingProject/ola?branch=master)
+[![Build Status](https://travis-ci.org/OpenLightingProject/ola.svg?branch=master)](https://travis-ci.org/OpenLightingProject/ola) [![Coverity Scan Status](https://scan.coverity.com/projects/3514/badge.svg)](https://scan.coverity.com/projects/3514) [![Coverage Status](https://coveralls.io/repos/OpenLightingProject/ola/badge.svg?branch=master)](https://coveralls.io/r/OpenLightingProject/ola?branch=master)
 
 The Open Lighting Architecture (OLA) is a framework for controlling
 entertainment lighting equipment. Within the entertainment lighting industry,

doxygen/examples/stdin_handler.cpp

@@ -21,6 +21,9 @@
 #include <ola/io/StdinHandler.h>
 #include <iostream>
 
+/**
+ * @brief An example StdinHandler.
+ */
 class ExampleStdinHandler {
  public:
   ExampleStdinHandler()

doxygen/namespaces.dox

@@ -5,6 +5,9 @@
  * @namespace ola::acn
  * @brief ACN related code.
  *
+ * @namespace ola::base
+ * @brief Core base functionality (arrays, exit codes, flags, versioning).
+ *
  * @namespace ola::client
  * @brief OLA C++ API
  *
@@ -65,6 +68,9 @@
  * @namespace ola::plugin::milinst
  * @brief Code for Milford Instruments devices.
  *
+ * @namespace ola::plugin::nanoleaf
+ * @brief Code for Nanoleaf Aurora.
+ *
  * @namespace ola::plugin::opendmx
  * @brief Code for the Enttec OpenDMX.
  *
@@ -89,6 +95,9 @@
  * @namespace ola::plugin::spi
  * @brief Code for SPI devices.
  *
+ * @namespace ola::plugin::spidmx
+ * @brief Code for receiving DMX using SPI devices.
+ *
  * @namespace ola::plugin::stageprofi
  * @brief Code for Stageprofi devices.
  *

include/ola/base/Version.h.in

@@ -34,6 +34,7 @@ namespace base {
 /**
  * @class Version ola/base/Version.h
  * @brief Provides version information.
+ *
  * OLA Version numbers are in the form major.minor.revision e.g. @VERSION@
  */
 class Version {

include/ola/io/InputBuffer.h

@@ -14,7 +14,7 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  *
  * InputBuffer.h
- * An Abstract base class that represents a block of memory tha can be read
+ * An Abstract base class that represents a block of memory that can be read
  * from.
  * Copyright (C) 2012 Simon Newton
  */

plugins/generate-html.sh

@@ -0,0 +1,56 @@
+#!/bin/sh
+
+if [ $# != 1 ]; then
+  echo "Usage: $0 <output_dir>"
+  exit 1;
+fi
+
+output_dir=$1
+if [ ! -d $output_dir ]; then
+  echo $output_dir is not a directory
+  exit 1;
+fi
+
+index_file=$output_dir/index.html;
+
+echo "Output dir: $output_dir";
+echo "Index file: $index_file";
+
+cat << 'EOF' > $index_file
+<html>
+<head>
+<title>Plugin config files for the Open Lighting Architecture</title>
+</head>
+<body>
+<h1>Plugin config files for the <a href="https://openlighting.org/ola/">Open Lighting Architecture</a></h1>
+<ul>
+EOF
+
+config_prefix=$(grep ::OLA_CONFIG_PREFIX ../olad/plugin_api/Preferences.cpp | sed -e 's/const char FileBackedPreferences::OLA_CONFIG_PREFIX\[\] = "//' -e 's/";$//');
+echo "Config prefix: $config_prefix";
+config_suffix=$(grep ::OLA_CONFIG_SUFFIX ../olad/plugin_api/Preferences.cpp | sed -e 's/const char FileBackedPreferences::OLA_CONFIG_SUFFIX\[\] = "//' -e 's/";$//');
+echo "Config suffix: $config_suffix";
+
+for readme_file in */README.md; do
+  echo "Generating from $readme_file";
+  plugin_dir=$(dirname $readme_file);
+  echo "Plugin dir: $plugin_dir";
+  plugin_name=$(grep ::PLUGIN_NAME $plugin_dir/*Plugin.cpp | sed -e 's/const char .*Plugin::PLUGIN_NAME\[\] = "//' -e 's/";$//');
+  echo "Plugin name: $plugin_name";
+  plugin_prefix=$(grep ::PLUGIN_PREFIX $plugin_dir/*Plugin.cpp | sed -e 's/const char .*Plugin::PLUGIN_PREFIX\[\] = "//' -e 's/";$//');
+  echo "Plugin prefix: $plugin_prefix";
+  config_file=$config_prefix$plugin_prefix$config_suffix;
+  output_file=$output_dir/$config_file.html;
+  page_title="$plugin_name Plugin ($config_file)";
+  echo "Config file: $config_file";
+  pandoc -f markdown_github -t html -s $plugin_dir/README.md -B pandoc-html-index.html -A pandoc-html-index.html -o $output_file -T "$page_title"
+  sed -i -e 's/ – <\/title>/<\/title>/' $output_file
+  chmod a+r $output_file;
+  echo "<li><a href='./$config_file.html'>$page_title</a></li>" >> $index_file
+done
+
+cat << 'EOF' >> $index_file
+</ul>
+</body>
+</html>
+EOF

plugins/pandoc-html-index.html

@@ -0,0 +1 @@
+<a href="index.html">Return to Main Contents</a>