add a test to check that returns are placed before since and note in …

…Doxygen
qgis · Dec 16, 2017 · e6f657c · e6f657c
1 parent 92751d4
commit e6f657c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/tests/code_layout/CMakeLists.txt b/tests/code_layout/CMakeLists.txt
@@ -8,6 +8,8 @@ ADD_TEST(qgis_sipify ${CMAKE_SOURCE_DIR}/tests/code_layout/test_sipify.sh)
 ADD_TEST(qgis_sip_include ${CMAKE_SOURCE_DIR}/tests/code_layout/test_sip_include.sh)
 ADD_TEST(qgis_sip_uptodate ${CMAKE_SOURCE_DIR}/tests/code_layout/test_sipfiles_uptodate.sh)
 
+ADD_TEST(qgis_doxygen_order ${CMAKE_SOURCE_DIR}/tests/code_layout/test_doxygen_order.sh)
+
 IF (WITH_APIDOC)
   INCLUDE(UsePythonTest)
   ADD_PYTHON_TEST(PyQgsDocCoverage ${CMAKE_SOURCE_DIR}/tests/code_layout/test_qgsdoccoverage.py)

diff --git a/tests/code_layout/test_doxygen_order.sh b/tests/code_layout/test_doxygen_order.sh
@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+
+# check that returns are placed before note and since
+output=$(unbuffer ag --noaffinity --file-search-regex '\.h$' --multiline '\\(note|since)[^\n]+(\n\s*\* [^\n]+)*\n\s*\* \\return' ${TRAVIS_BUILD_DIR} | tee /dev/stderr)
+if [[ ! -z $output ]]; then
+  echo -e "\n\x1B[31m*** Docstring computation: \\\return(s) should be placed before \\\note and \\since\x1B[0m"
+  exit 1
+fi