Skip to content


add a test to check that returns are placed before since and note in …
Browse files Browse the repository at this point in the history
  • Loading branch information
3nids committed Dec 16, 2017
1 parent 92751d4 commit e6f657c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
2 changes: 2 additions & 0 deletions tests/code_layout/CMakeLists.txt
Expand Up @@ -8,6 +8,8 @@ ADD_TEST(qgis_sipify ${CMAKE_SOURCE_DIR}/tests/code_layout/
ADD_TEST(qgis_sip_include ${CMAKE_SOURCE_DIR}/tests/code_layout/
ADD_TEST(qgis_sip_uptodate ${CMAKE_SOURCE_DIR}/tests/code_layout/

ADD_TEST(qgis_doxygen_order ${CMAKE_SOURCE_DIR}/tests/code_layout/

ADD_PYTHON_TEST(PyQgsDocCoverage ${CMAKE_SOURCE_DIR}/tests/code_layout/
Expand Down
9 changes: 9 additions & 0 deletions tests/code_layout/
@@ -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

0 comments on commit e6f657c

Please sign in to comment.