Fix the Sphinx build
authorAaron Ballman <aaron@aaronballman.com>
Mon, 14 Feb 2022 14:43:47 +0000 (09:43 -0500)
committerAaron Ballman <aaron@aaronballman.com>
Mon, 14 Feb 2022 14:43:47 +0000 (09:43 -0500)
Add a heading to appease the Sphinx bot, and add some basic
documentation for [[_Noreturn]].

clang/include/clang/Basic/AttrDocs.td

index 0e871b4..f61c9d0 100644 (file)
@@ -487,10 +487,14 @@ pointer type.
 
 def CXX11NoReturnDocs : Documentation {
   let Category = DocCatFunction;
+  let Heading = "noreturn, _Noreturn";
   let Content = [{
 A function declared as ``[[noreturn]]`` shall not return to its caller. The
 compiler will generate a diagnostic for a function declared as ``[[noreturn]]``
 that appears to be capable of returning to its caller.
+
+The ``[[_Noreturn]]`` spelling is deprecated and only exists to ease code
+migration for code using ``[[noreturn]]`` after including ``<stdnoreturn.h>``.
   }];
 }