aboutsummaryrefslogtreecommitdiffstats
path: root/include/llvm/Bitcode/Archive.h
diff options
context:
space:
mode:
authorDmitri Gribenko <gribozavr@gmail.com>2012-08-23 16:54:08 +0000
committerDmitri Gribenko <gribozavr@gmail.com>2012-08-23 16:54:08 +0000
commita00b80b04c5edb08639c1c6b32e9231fd8b066f7 (patch)
tree5489f28048894e81c7222b0942cf3e4130a11445 /include/llvm/Bitcode/Archive.h
parent9d9f5a5855a711b1154e178e26f3766dc21d846a (diff)
downloadexternal_llvm-a00b80b04c5edb08639c1c6b32e9231fd8b066f7.zip
external_llvm-a00b80b04c5edb08639c1c6b32e9231fd8b066f7.tar.gz
external_llvm-a00b80b04c5edb08639c1c6b32e9231fd8b066f7.tar.bz2
Fix a bunch of -Wdocumentation warnings.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@162446 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/Bitcode/Archive.h')
-rw-r--r--include/llvm/Bitcode/Archive.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/llvm/Bitcode/Archive.h b/include/llvm/Bitcode/Archive.h
index 3c75e58..c1c3ec0 100644
--- a/include/llvm/Bitcode/Archive.h
+++ b/include/llvm/Bitcode/Archive.h
@@ -415,8 +415,8 @@ class Archive {
/// name will be truncated at 15 characters. If \p Compress is specified,
/// all archive members will be compressed before being written. If
/// \p PrintSymTab is true, the symbol table will be printed to std::cout.
- /// @returns true if an error occurred, \p error set to error message
- /// @returns false if the writing succeeded.
+ /// @returns true if an error occurred, \p error set to error message;
+ /// returns false if the writing succeeded.
/// @brief Write (possibly modified) archive contents to disk
bool writeToDisk(
bool CreateSymbolTable=false, ///< Create Symbol table
@@ -480,8 +480,8 @@ class Archive {
/// Writes one ArchiveMember to an ofstream. If an error occurs, returns
/// false, otherwise true. If an error occurs and error is non-null then
/// it will be set to an error message.
- /// @returns false Writing member succeeded
- /// @returns true Writing member failed, \p error set to error message
+ /// @returns false if writing member succeeded,
+ /// returns true if writing member failed, \p error set to error message.
bool writeMember(
const ArchiveMember& member, ///< The member to be written
std::ofstream& ARFile, ///< The file to write member onto