diff options
author | James Dennett <jdennett@google.com> | 2012-06-15 22:10:14 +0000 |
---|---|---|
committer | James Dennett <jdennett@google.com> | 2012-06-15 22:10:14 +0000 |
commit | 2ee5ba35febf830d366b65dd0dcbf8e291c41342 (patch) | |
tree | ae1a05c425a156ee8a958cc43f61b53e24d430c7 /lib/CodeGen/CGObjCRuntime.h | |
parent | 94c2bf14765c33ad50a3ef50727677337b71ee8d (diff) |
Documentation cleanup:
* Escaped Objective-C @keywords in Doxygen comments;
* Documented more accurate \params;
* Exposed some more summaries using \brief.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@158559 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'lib/CodeGen/CGObjCRuntime.h')
-rw-r--r-- | lib/CodeGen/CGObjCRuntime.h | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/lib/CodeGen/CGObjCRuntime.h b/lib/CodeGen/CGObjCRuntime.h index 135a080ce6..219a3e4df0 100644 --- a/lib/CodeGen/CGObjCRuntime.h +++ b/lib/CodeGen/CGObjCRuntime.h @@ -91,20 +91,20 @@ protected: llvm::Value *Offset); /// Emits a try / catch statement. This function is intended to be called by /// subclasses, and provides a generic mechanism for generating these, which - /// should be usable by all runtimes. The caller must provide the functions to - /// call when entering and exiting a @catch() block, and the function used to - /// rethrow exceptions. If the begin and end catch functions are NULL, then - /// the function assumes that the EH personality function provides the - /// thrown object directly. + /// should be usable by all runtimes. The caller must provide the functions + /// to call when entering and exiting a \@catch() block, and the function + /// used to rethrow exceptions. If the begin and end catch functions are + /// NULL, then the function assumes that the EH personality function provides + /// the thrown object directly. void EmitTryCatchStmt(CodeGenFunction &CGF, const ObjCAtTryStmt &S, llvm::Constant *beginCatchFn, llvm::Constant *endCatchFn, llvm::Constant *exceptionRethrowFn); - /// Emits an @synchronize() statement, using the syncEnterFn and syncExitFn - /// arguments as the functions called to lock and unlock the object. This - /// function can be called by subclasses that use zero-cost exception - /// handling. + /// Emits an \@synchronize() statement, using the \p syncEnterFn and + /// \p syncExitFn arguments as the functions called to lock and unlock + /// the object. This function can be called by subclasses that use + /// zero-cost exception handling. void EmitAtSynchronizedStmt(CodeGenFunction &CGF, const ObjCAtSynchronizedStmt &S, llvm::Function *syncEnterFn, |