backend/sdoc_source_code: reader_c: fix a small edge case related to code comments

This is a result of fast coding. Was overlooked that the range was asserted by the itest incorrectly.

Author: stanislaw

strictdoc/backend/sdoc_source_code/reader_c.py

@@ -261,9 +261,15 @@ def read(
                 function_markers = []
                 function_comment_node = None
                 function_comment_text = None
+
+                # In the condition below, it is important that the comment is
+                # considered a function comment only if it there are no empty
+                # lines between the comment and function.
                 if (
                     node_.prev_sibling is not None
                     and node_.prev_sibling.type == "comment"
+                    and (node_.prev_sibling.end_point[0] + 1)
+                    == node_.start_point[0]
                 ):
                     function_comment_node = node_.prev_sibling
                     assert function_comment_node.text is not None, node_.text

tests/integration/features/test_reports/junit_xml/ctest/05_user_example/test.itest

@@ -14,8 +14,8 @@ RUN: %check_exists --file "%S/Output/html/_source_files/tests/test1.cpp.html"
 
 # Ensure that the test report document has the right content.
 RUN: %cat "%S/Output/html/%THIS_TEST_FOLDER/reports/tests_unit.ctest.junit.html" | filecheck %s --check-prefix CHECK-TEST-REPORT
-CHECK-TEST-REPORT:href="../../_source_files/tests/test1.cpp.html#MyTestSuiteName.TestName#15#21">
-CHECK-TEST-REPORT: tests/test1.cpp, <i>lines: 15-21</i>, function TEST(MyTestSuiteName, TestName)
+CHECK-TEST-REPORT:href="../../_source_files/tests/test1.cpp.html#MyTestSuiteName.TestName#17#21">
+CHECK-TEST-REPORT: tests/test1.cpp, <i>lines: 17-21</i>, function TEST(MyTestSuiteName, TestName)
 CHECK-TEST-REPORT:href="../../_source_files/tests/test1.cpp.html#MyTestHelper.TestName2#32#36">
 CHECK-TEST-REPORT: tests/test1.cpp, <i>lines: 32-36</i>, function TEST_F(MyTestHelper, TestName2)
 CHECK-TEST-REPORT:href="../../_source_files/tests/test1.cpp.html#MyTestPattern/MyTestHelperPattern.TestName3/1#44#48">

tests/integration/features/test_reports/junit_xml/gtest/05_user_example/test.itest

@@ -14,8 +14,8 @@ RUN: %check_exists --file "%S/Output/html/_source_files/tests/test1.cpp.html"
 
 # Ensure that the test report document has the right content.
 RUN: %cat "%S/Output/html/%THIS_TEST_FOLDER/reports/tests_unit.gtest.junit.html" | filecheck %s --check-prefix CHECK-TEST-REPORT
-CHECK-TEST-REPORT:href="../../_source_files/tests/test1.cpp.html#MyTestSuiteName.TestName#15#21">
-CHECK-TEST-REPORT: tests/test1.cpp, <i>lines: 15-21</i>, function TEST(MyTestSuiteName, TestName)
+CHECK-TEST-REPORT:href="../../_source_files/tests/test1.cpp.html#MyTestSuiteName.TestName#17#21">
+CHECK-TEST-REPORT: tests/test1.cpp, <i>lines: 17-21</i>, function TEST(MyTestSuiteName, TestName)
 CHECK-TEST-REPORT:href="../../_source_files/tests/test1.cpp.html#MyTestHelper.TestName2#32#36">
 CHECK-TEST-REPORT: tests/test1.cpp, <i>lines: 32-36</i>, function TEST_F(MyTestHelper, TestName2)
 CHECK-TEST-REPORT:href="../../_source_files/tests/test1.cpp.html#MyTestPattern/MyTestHelperPattern.TestName3/1#44#48">

tests/integration/features/test_reports/junit_xml/gtest/06_user_example_still_does_not_work/test.itest

@@ -14,7 +14,7 @@ RUN: %check_exists --file "%S/Output/html/_source_files/tests/test1.cpp.html"
 
 # Ensure that the test report document has the right content.
 RUN: %cat "%S/Output/html/%THIS_TEST_FOLDER/reports/tests_unit.gtest.junit.html" | filecheck %s --check-prefix CHECK-TEST-REPORT
-CHECK-TEST-REPORT:href="../../_source_files/tests/test1.cpp.html#TestCaseVc.TestCase#15#21">
-CHECK-TEST-REPORT: tests/test1.cpp, <i>lines: 15-21</i>, function TEST(TestCaseVc, TestCase)
+CHECK-TEST-REPORT:href="../../_source_files/tests/test1.cpp.html#TestCaseVc.TestCase#17#21">
+CHECK-TEST-REPORT: tests/test1.cpp, <i>lines: 17-21</i>, function TEST(TestCaseVc, TestCase)
 CHECK-TEST-REPORT:href="../../_source_files/tests/test1.cpp.html#TestCaseVc.Steering1#23#27">
 CHECK-TEST-REPORT: tests/test1.cpp, <i>lines: 23-27</i>, function TEST(TestCaseVc, Steering1)