[lldb] Add a blurb about not including private headers (llvm#162404)

JDevlieghere · JDevlieghere · commit becc950bb8d6 · 2025-10-09T11:22:27.000-07:00
Add a blurb about not including private headers in the API tests. (cherry picked from commit 9527f93)
diff --git a/lldb/unittests/API/CMakeLists.txt b/lldb/unittests/API/CMakeLists.txt
@@ -11,7 +11,8 @@ add_lldb_unittest(APITests
   )
 
 # Build with -Wdocumentation. This relies on the tests including all the API
-# headers through API/LLDB.h.
+# headers through API/LLDB.h. It also means that the API tests cannot include
+# private headers.
 check_cxx_compiler_flag("-Wdocumentation"
                         CXX_SUPPORTS_DOCUMENTATION)
 if (CXX_SUPPORTS_DOCUMENTATION)

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,8 @@ add_lldb_unittest(APITests`
`11`	`11`	`)`
`12`	`12`
`13`	`13`	`# Build with -Wdocumentation. This relies on the tests including all the API`
`14`		`-# headers through API/LLDB.h.`
	`14`	`+# headers through API/LLDB.h. It also means that the API tests cannot include`
	`15`	`+# private headers.`
`15`	`16`	`check_cxx_compiler_flag("-Wdocumentation"`
`16`	`17`	`CXX_SUPPORTS_DOCUMENTATION)`
`17`	`18`	`if (CXX_SUPPORTS_DOCUMENTATION)`