mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2025-01-25 05:15:58 +00:00
Update comment. NFC.
llvm-svn: 235417
This commit is contained in:
parent
3991a891cf
commit
fdb0fb38b7
@ -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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user