[clang] f037082 - Fix the Sphinx build

Aaron Ballman via cfe-commits cfe-commits at lists.llvm.org
Mon Feb 14 06:44:39 PST 2022


Author: Aaron Ballman
Date: 2022-02-14T09:43:47-05:00
New Revision: f037082714a0fd48568a1f10ef3e4db8919e1523

URL: https://github.com/llvm/llvm-project/commit/f037082714a0fd48568a1f10ef3e4db8919e1523
DIFF: https://github.com/llvm/llvm-project/commit/f037082714a0fd48568a1f10ef3e4db8919e1523.diff

LOG: Fix the Sphinx build

Add a heading to appease the Sphinx bot, and add some basic
documentation for [[_Noreturn]].

Added: 
    

Modified: 
    clang/include/clang/Basic/AttrDocs.td

Removed: 
    


################################################################################
diff  --git a/clang/include/clang/Basic/AttrDocs.td b/clang/include/clang/Basic/AttrDocs.td
index 0e871b4aaf1a..f61c9d00c444 100644
--- a/clang/include/clang/Basic/AttrDocs.td
+++ b/clang/include/clang/Basic/AttrDocs.td
@@ -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>``.
   }];
 }
 


        


More information about the cfe-commits mailing list