Update comment. NFC.
authorLang Hames <lhames@gmail.com>
Tue, 21 Apr 2015 21:15:35 +0000 (21:15 +0000)
committerLang Hames <lhames@gmail.com>
Tue, 21 Apr 2015 21:15:35 +0000 (21:15 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@235417 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/IR/TypeBuilder.h

index 5a29e1e..d2c6f00 100644 (file)
@@ -34,6 +34,8 @@ namespace llvm {
 /// you'll need to specialize it.  For example, say you want to call a
 /// function defined externally as:
 ///
+/// \code{.cpp}
+///
 ///   struct MyType {
 ///     int32 a;
 ///     int32 *b;
@@ -41,12 +43,16 @@ namespace llvm {
 ///   };
 ///   int8 AFunction(struct MyType *value);
 ///
+/// \endcode
+///
 /// You'll want to use
 ///   Function::Create(TypeBuilder<types::i<8>(MyType*), true>::get(), ...)
 /// to declare the function, but when you first try this, your compiler will
 /// complain that TypeBuilder<MyType, true>::get() doesn't exist. To fix this,
 /// write:
 ///
+/// \code{.cpp}
+///
 ///   namespace llvm {
 ///   template<bool xcompile> class TypeBuilder<MyType, xcompile> {
 ///   public:
@@ -57,7 +63,7 @@ namespace llvm {
 ///         TypeBuilder<types::i<32>, xcompile>::get(Context),
 ///         TypeBuilder<types::i<32>*, xcompile>::get(Context),
 ///         TypeBuilder<types::i<8>*[], xcompile>::get(Context),
-///         NULL);
+///         nullptr);
 ///     }
 ///
 ///     // You may find this a convenient place to put some constants
@@ -71,6 +77,8 @@ namespace llvm {
 ///   }
 ///   }  // namespace llvm
 ///
+/// \endcode
+///
 /// TypeBuilder cannot handle recursive types or types you only know at runtime.
 /// If you try to give it a recursive type, it will deadlock, infinitely
 /// recurse, or do something similarly undesirable.