llvm.org GIT mirror llvm / 37446cb
[cleanup] Switch comments to use '\brief' style instead of '@brief' style, and remove some unnecessary comments (the code is perfectly self-documenting here). Also clang-format the function declarations as they wrap cleanly now. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@199084 91177308-0d34-0410-b5e6-96231b3b80d8 Chandler Carruth 6 years ago
1 changed file(s) with 12 addition(s) and 18 deletion(s). Raw diff Collapse all Expand all
2828 class Module;
2929 class Function;
3030
31 /// @brief An enumeration to specify the action to be taken if errors found.
31 /// \brief An enumeration to specify the action to be taken if errors found.
3232 ///
3333 /// This enumeration is used in the functions below to indicate what should
3434 /// happen if the verifier finds errors. Each of the functions that uses
4040 ReturnStatusAction ///< verifyModule will just return true
4141 };
4242
43 /// @brief Create a verifier pass.
43 /// \brief Create a verifier pass.
4444 ///
4545 /// Check a module or function for validity. When the pass is used, the
4646 /// action indicated by the \p action argument will be used if errors are
4747 /// found.
48 FunctionPass *createVerifierPass(
49 VerifierFailureAction action = AbortProcessAction ///< Action to take
50 );
48 FunctionPass *
49 createVerifierPass(VerifierFailureAction action = AbortProcessAction);
5150
52 /// @brief Check a module for errors.
51 /// \brief Check a module for errors.
5352 ///
5453 /// If there are no errors, the function returns false. If an error is found,
5554 /// the action taken depends on the \p action parameter.
5655 /// This should only be used for debugging, because it plays games with
5756 /// PassManagers and stuff.
57 bool verifyModule(const Module &M,
58 VerifierFailureAction action = AbortProcessAction,
59 std::string *ErrorInfo = 0);
5860
59 bool verifyModule(
60 const Module &M, ///< The module to be verified
61 VerifierFailureAction action = AbortProcessAction, ///< Action to take
62 std::string *ErrorInfo = 0 ///< Information about failures.
63 );
64
65 // verifyFunction - Check a function for errors, useful for use when debugging a
66 // pass.
67 bool verifyFunction(
68 const Function &F, ///< The function to be verified
69 VerifierFailureAction action = AbortProcessAction ///< Action to take
70 );
61 /// \brief Check a function for errors, useful for use when debugging a
62 /// pass.
63 bool verifyFunction(const Function &F,
64 VerifierFailureAction action = AbortProcessAction);
7165
7266 } // End llvm namespace
7367