Add doxygen checker (#1540)

* Fixed Doxygen issues
 * Updated Doxygen config
 * Added new script to test whether doxygen generation was successful or not
 * Added to Travis CI

JerryScript-DCO-1.0-Signed-off-by: László Langó llango.u-szeged@partner.samsung.com

tools/apt-get-install-deps.sh

@@ -18,4 +18,5 @@ sudo apt-get update -q
 sudo apt-get install -q -y \
     make cmake \
     gcc gcc-multilib \
+    doxygen \
     cppcheck vera++ python

tools/check-doxygen.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+# Copyright JS Foundation and other contributors, http://js.foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+echo -n "Generating documentation with doxygen ..."
+DOXYGEN_WARNINGS=$((doxygen > /dev/null) 2>&1)
+echo " finished"
+
+if [ -n "$DOXYGEN_WARNINGS" ]
+then
+  echo "$DOXYGEN_WARNINGS"
+  exit 1
+fi

tools/run-tests.py

@@ -30,6 +30,7 @@ parser.add_argument('--check-signed-off', action='store_true', default=False, he
 parser.add_argument('--check-signed-off-tolerant', action='store_true', default=False, help='Run signed-off check in tolerant mode')
 parser.add_argument('--check-signed-off-travis', action='store_true', default=False, help='Run signed-off check in tolerant mode if on Travis CI and not checking a pull request')
 parser.add_argument('--check-cppcheck', action='store_true', default=False, help='Run cppcheck')
+parser.add_argument('--check-doxygen', action='store_true', default=False, help='Run doxygen')
 parser.add_argument('--check-vera', action='store_true', default=False, help='Run vera check')
 parser.add_argument('--check-license', action='store_true', default=False, help='Run license check')
 parser.add_argument('--buildoption-test', action='store_true', default=False, help='Run buildoption-test')
@@ -231,6 +232,9 @@ def main():
     if not ret and (script_args.all or script_args.check_cppcheck):
         ret = run_check([CPPCHECK_SCRIPT])
 
+    if not ret and (script_args.all or script_args.check_doxygen):
+        ret = run_check([DOXYGEN_SCRIPT])
+
     if not ret and (script_args.all or script_args.check_vera):
         ret = run_check([VERA_SCRIPT])
 

tools/settings.py

@@ -26,9 +26,10 @@ TEST262_TEST_SUITE_DIR = path.join(PROJECT_DIR, 'tests/test262')
 
 BUILD_SCRIPT = path.join(TOOLS_DIR, 'build.py')
 CPPCHECK_SCRIPT = path.join(TOOLS_DIR, 'check-cppcheck.sh')
-SIGNED_OFF_SCRIPT = path.join(TOOLS_DIR, 'check-signed-off.sh')
-VERA_SCRIPT = path.join(TOOLS_DIR, 'check-vera.sh')
+DOXYGEN_SCRIPT = path.join(TOOLS_DIR, 'check-doxygen.sh')
 LICENSE_SCRIPT = path.join(TOOLS_DIR, 'check-license.py')
+SIGNED_OFF_SCRIPT = path.join(TOOLS_DIR, 'check-signed-off.sh')
 TEST_RUNNER_SCRIPT = path.join(TOOLS_DIR, 'runners/run-test-suite.sh')
 TEST262_RUNNER_SCRIPT = path.join(TOOLS_DIR, 'runners/run-test-suite-test262.sh')
+VERA_SCRIPT = path.join(TOOLS_DIR, 'check-vera.sh')
 UNITTEST_RUNNER_SCRIPT = path.join(TOOLS_DIR, 'runners/run-unittests.sh')