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

JDevlieghere · web-flow · commit 9527f9338f9d · 2025-10-08T12:55:42.000-07:00
Add a blurb about not including private headers in the API tests.
diff --git a/lldb/unittests/API/CMakeLists.txt b/lldb/unittests/API/CMakeLists.txt
@@ -10,7 +10,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
`@@ -10,7 +10,8 @@ add_lldb_unittest(APITests`
`10`	`10`	`)`
`11`	`11`
`12`	`12`	`# Build with -Wdocumentation. This relies on the tests including all the API`
`13`		`-# headers through API/LLDB.h.`
	`13`	`+# headers through API/LLDB.h. It also means that the API tests cannot include`
	`14`	`+# private headers.`
`14`	`15`	`check_cxx_compiler_flag("-Wdocumentation"`
`15`	`16`	`CXX_SUPPORTS_DOCUMENTATION)`
`16`	`17`	`if (CXX_SUPPORTS_DOCUMENTATION)`