[llvm-commits] [llvm] r40854 - in /llvm/trunk: include/llvm/Bitcode/Archive.h include/llvm/CodeGen/AsmPrinter.h include/llvm/Constants.h include/llvm/Linker.h include/llvm/Support/LLVMBuilder.h include/llvm/Support/Mangler.h include/llvm/Support/MemoryBuffer.h include/llvm/Support/Streams.h include/llvm/System/Path.h include/llvm/Target/TargetAsmInfo.h lib/CodeGen/DwarfWriter.cpp lib/Target/TargetData.cpp lib/VMCore/Verifier.cpp
Reid Spencer
rspencer at reidspencer.com
Sun Aug 5 13:06:07 PDT 2007
Author: reid
Date: Sun Aug 5 15:06:04 2007
New Revision: 40854
URL: http://llvm.org/viewvc/llvm-project?rev=40854&view=rev
Log:
Fix minor doxygen nits.
Modified:
llvm/trunk/include/llvm/Bitcode/Archive.h
llvm/trunk/include/llvm/CodeGen/AsmPrinter.h
llvm/trunk/include/llvm/Constants.h
llvm/trunk/include/llvm/Linker.h
llvm/trunk/include/llvm/Support/LLVMBuilder.h
llvm/trunk/include/llvm/Support/Mangler.h
llvm/trunk/include/llvm/Support/MemoryBuffer.h
llvm/trunk/include/llvm/Support/Streams.h
llvm/trunk/include/llvm/System/Path.h
llvm/trunk/include/llvm/Target/TargetAsmInfo.h
llvm/trunk/lib/CodeGen/DwarfWriter.cpp
llvm/trunk/lib/Target/TargetData.cpp
llvm/trunk/lib/VMCore/Verifier.cpp
Modified: llvm/trunk/include/llvm/Bitcode/Archive.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Bitcode/Archive.h?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Bitcode/Archive.h (original)
+++ llvm/trunk/include/llvm/Bitcode/Archive.h Sun Aug 5 15:06:04 2007
@@ -463,6 +463,8 @@
/// into memory.
Archive(const sys::Path& filename);
+ /// @param data The symbol table data to be parsed
+ /// @param len The length of the symbol table data
/// @param error Set to address of a std::string to get error messages
/// @returns false on error
/// @brief Parse the symbol table at \p data.
@@ -476,17 +478,17 @@
std::string* error ///< Optional error message catcher
);
- /// @param error Set to address of a std::string to get error messages
+ /// @param ErrMessage Set to address of a std::string to get error messages
/// @returns false on error
/// @brief Check that the archive signature is correct
bool checkSignature(std::string* ErrMessage);
- /// @param error Set to address of a std::string to get error messages
+ /// @param ErrMessage Set to address of a std::string to get error messages
/// @returns false on error
/// @brief Load the entire archive.
bool loadArchive(std::string* ErrMessage);
- /// @param error Set to address of a std::string to get error messages
+ /// @param ErrMessage Set to address of a std::string to get error messages
/// @returns false on error
/// @brief Load just the symbol table.
bool loadSymbolTable(std::string* ErrMessage);
Modified: llvm/trunk/include/llvm/CodeGen/AsmPrinter.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/CodeGen/AsmPrinter.h?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/include/llvm/CodeGen/AsmPrinter.h (original)
+++ llvm/trunk/include/llvm/CodeGen/AsmPrinter.h Sun Aug 5 15:06:04 2007
@@ -240,7 +240,7 @@
/// EmitString - Emit a string with quotes and a null terminator.
/// Special characters are emitted properly.
- /// \literal (Eg. '\t') \endliteral
+ /// @verbatim (Eg. '\t') @endverbatim
void EmitString(const std::string &String) const;
//===------------------------------------------------------------------===//
Modified: llvm/trunk/include/llvm/Constants.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Constants.h?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Constants.h (original)
+++ llvm/trunk/include/llvm/Constants.h Sun Aug 5 15:06:04 2007
@@ -311,7 +311,9 @@
bool isString() const;
/// isCString - This method returns true if the array is a string (see
+ /// @verbatim
/// isString) and it ends in a null byte \0 and does not contains any other
+ /// @endverbatim
/// null bytes except its terminator.
bool isCString() const;
Modified: llvm/trunk/include/llvm/Linker.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Linker.h?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Linker.h (original)
+++ llvm/trunk/include/llvm/Linker.h Sun Aug 5 15:06:04 2007
@@ -204,7 +204,7 @@
/// found in one library, based on the unresolved symbols in the composite
/// module.The \p Library should be the base name of a library, as if given
/// with the -l option of a linker tool. The Linker's LibPaths are searched
- /// for the \P Library and if found, it will be linked in with via the
+ /// for the \p Library and if found, it will be linked in with via the
/// LinkInArchive method. If an error occurs, the Linker's error string is
/// set.
/// @see LinkInArchive
Modified: llvm/trunk/include/llvm/Support/LLVMBuilder.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Support/LLVMBuilder.h?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Support/LLVMBuilder.h (original)
+++ llvm/trunk/include/llvm/Support/LLVMBuilder.h Sun Aug 5 15:06:04 2007
@@ -89,7 +89,7 @@
return Insert(new ReturnInst());
}
- /// CreateRet - Create a 'ret <val>' instruction.
+ /// @verbatim CreateRet - Create a 'ret <val>' instruction. @endverbatim
ReturnInst *CreateRet(Value *V) {
return Insert(new ReturnInst(V));
}
Modified: llvm/trunk/include/llvm/Support/Mangler.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Support/Mangler.h?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Support/Mangler.h (original)
+++ llvm/trunk/include/llvm/Support/Mangler.h Sun Aug 5 15:06:04 2007
@@ -71,7 +71,7 @@
void setUseQuotes(bool Val) { UseQuotes = Val; }
/// setPreserveAsmNames - If the mangler should not strip off the asm name
- /// identifier (\001), this should be set.
+ /// @verbatim identifier (\001), this should be set. @endverbatim
void setPreserveAsmNames(bool Val) { PreserveAsmNames = Val; }
/// Acceptable Characters - This allows the target to specify which characters
Modified: llvm/trunk/include/llvm/Support/MemoryBuffer.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Support/MemoryBuffer.h?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Support/MemoryBuffer.h (original)
+++ llvm/trunk/include/llvm/Support/MemoryBuffer.h Sun Aug 5 15:06:04 2007
@@ -23,7 +23,7 @@
/// of memory, and provides simple methods for reading files and standard input
/// into a memory buffer. In addition to basic access to the characters in the
/// file, this interface guarantees you can read one character past the end of
-/// the file, and that this character will read as '\0'.
+/// @verbatim the file, and that this character will read as '\0'. @endverbatim
class MemoryBuffer {
const char *BufferStart; // Start of the buffer.
const char *BufferEnd; // End of the buffer.
Modified: llvm/trunk/include/llvm/Support/Streams.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Support/Streams.h?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Support/Streams.h (original)
+++ llvm/trunk/include/llvm/Support/Streams.h Sun Aug 5 15:06:04 2007
@@ -21,8 +21,8 @@
/// BaseStream - Acts like the STL streams. It's a wrapper for the std::cerr,
/// std::cout, std::cin, etc. streams. However, it doesn't require #including
- /// <iostream> in every file (doing so increases static c'tors & d'tors in the
- /// object code).
+ /// @verbatim <iostream> @endverbatm in every file (doing so increases static
+ /// c'tors & d'tors in the object code).
///
template <typename StreamTy>
class BaseStream {
Modified: llvm/trunk/include/llvm/System/Path.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/System/Path.h?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/include/llvm/System/Path.h (original)
+++ llvm/trunk/include/llvm/System/Path.h Sun Aug 5 15:06:04 2007
@@ -177,7 +177,8 @@
/// This constructor will accept a character range as a path. No checking
/// is done on this path to determine if it is valid. To determine
/// validity of the path, use the isValid method.
- /// @param p The path to assign.
+ /// @param StrStart A pointer to the first character of the path name
+ /// @param StrLen The length of the path name at StrStart
/// @brief Construct a Path from a string.
explicit Path(const char *StrStart, unsigned StrLen)
: path(StrStart, StrStart+StrLen) {}
@@ -280,7 +281,7 @@
/// This function determines if the path name is absolute, as opposed to
/// relative.
- /// @breif Determine if the path is absolute.
+ /// @brief Determine if the path is absolute.
bool isAbsolute() const;
/// This function opens the file associated with the path name provided by
@@ -512,6 +513,7 @@
/// directory, recursively. If the Path refers to a file, the
/// \p destroy_contents parameter is ignored.
/// @param destroy_contents Indicates whether the contents of a destroyed
+ /// @param Err An optional string to receive an error message.
/// directory should also be destroyed (recursively).
/// @returns false if the file/directory was destroyed, true on error.
/// @brief Removes the file or directory from the filesystem.
@@ -554,18 +556,19 @@
/// This constructor will accept a std::string as a path. No checking is
/// done on this path to determine if it is valid. To determine validity
/// of the path, use the isValid method.
- /// @param p The path to assign.
/// @brief Construct a Path from a string.
- explicit PathWithStatus(const std::string& p)
- : Path(p), status(), fsIsValid(false) {}
+ explicit PathWithStatus(
+ const std::string& p ///< The path to assign.
+ ) : Path(p), status(), fsIsValid(false) {}
/// This constructor will accept a character range as a path. No checking
/// is done on this path to determine if it is valid. To determine
/// validity of the path, use the isValid method.
- /// @param p The path to assign.
/// @brief Construct a Path from a string.
- explicit PathWithStatus(const char *StrStart, unsigned StrLen)
- : Path(StrStart, StrLen), status(), fsIsValid(false) {}
+ explicit PathWithStatus(
+ const char *StrStart, ///< Pointer to the first character of the path
+ unsigned StrLen ///< Length of the path.
+ ) : Path(StrStart, StrLen), status(), fsIsValid(false) {}
/// Makes a copy of \p that to \p this.
/// @returns \p this
Modified: llvm/trunk/include/llvm/Target/TargetAsmInfo.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Target/TargetAsmInfo.h?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Target/TargetAsmInfo.h (original)
+++ llvm/trunk/include/llvm/Target/TargetAsmInfo.h Sun Aug 5 15:06:04 2007
@@ -104,7 +104,7 @@
/// will enclose any GlobalVariable that points to a function.
/// For example, this is used by the IA64 backend to materialize
/// function descriptors, by decorating the ".data8" object with the
- /// \literal @fptr( ) \endliteral
+ /// @verbatim @fptr( ) @endverbatim
/// link-relocation operator.
///
const char *FunctionAddrPrefix; // Defaults to ""
@@ -190,7 +190,7 @@
const char *JumpTableDirective;
/// CStringSection - If not null, this allows for special handling of
- /// cstring constants (\0 terminated string that does not contain any
+ /// cstring constants (null terminated string that does not contain any
/// other null bytes) on this target. This is commonly supported as
/// ".cstring".
const char *CStringSection; // Defaults to NULL
@@ -230,8 +230,8 @@
/// LCOMMDirective - This is the name of a directive (if supported) that can
/// be used to efficiently declare a local (internal) block of zero
/// initialized data in the .bss/.data section. The syntax expected is:
- /// \literal <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
- /// \endliteral
+ /// @verbatim <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
+ /// @endverbatim
const char *LCOMMDirective; // Defaults to null.
const char *COMMDirective; // Defaults to "\t.comm\t".
Modified: llvm/trunk/lib/CodeGen/DwarfWriter.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/CodeGen/DwarfWriter.cpp?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/lib/CodeGen/DwarfWriter.cpp (original)
+++ llvm/trunk/lib/CodeGen/DwarfWriter.cpp Sun Aug 5 15:06:04 2007
@@ -58,9 +58,9 @@
//===----------------------------------------------------------------------===//
/// DWLabel - Labels are used to track locations in the assembler file.
-/// Labels appear in the form <prefix><Tag><Number>, where the tag is a
-/// category of label (Ex. location) and number is a value unique in that
-/// category.
+/// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
+/// where the tag is a category of label (Ex. location) and number is a value
+/// unique in that category.
class DWLabel {
public:
/// Tag - Label category tag. Should always be a staticly declared C string.
Modified: llvm/trunk/lib/Target/TargetData.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Target/TargetData.cpp?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/lib/Target/TargetData.cpp (original)
+++ llvm/trunk/lib/Target/TargetData.cpp Sun Aug 5 15:06:04 2007
@@ -146,10 +146,10 @@
<i>[E|e]</i>: Endianness. "E" specifies a big-endian target data model, "e"
specifies a little-endian target data model.
<br><br>
- <i>p:<size>:<abi_align>:<pref_align></i>: Pointer size, ABI and preferred
- alignment.
+ <i>p:@verbatim<size>:<abi_align>:<pref_align>@endverbatim</i>: Pointer size,
+ ABI and preferred alignment.
<br><br>
- <i><type><size>:<abi_align>:<pref_align></i>: Numeric type alignment. Type is
+ <i>@verbatim<type><size>:<abi_align>:<pref_align>@endverbatim</i>: Numeric type alignment. Type is
one of <i>i|f|v|a</i>, corresponding to integer, floating point, vector (aka
packed) or aggregate. Size indicates the size, e.g., 32 or 64 bits.
\p
Modified: llvm/trunk/lib/VMCore/Verifier.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/VMCore/Verifier.cpp?rev=40854&r1=40853&r2=40854&view=diff
==============================================================================
--- llvm/trunk/lib/VMCore/Verifier.cpp (original)
+++ llvm/trunk/lib/VMCore/Verifier.cpp Sun Aug 5 15:06:04 2007
@@ -370,6 +370,9 @@
ParamAttr::ByVal | ParamAttr::InReg |
ParamAttr::Nest | ParamAttr::StructRet;
+ const uint16_t MutuallyIncompatible2 =
+ ParamAttr::ZExt | ParamAttr::SExt;
+
const uint16_t IntegerTypeOnly =
ParamAttr::SExt | ParamAttr::ZExt;
@@ -386,6 +389,9 @@
uint16_t RetI = Attrs->getParamAttrs(0) & ReturnIncompatible;
Assert1(!RetI, "Attribute " + Attrs->getParamAttrsText(RetI) +
"should not apply to functions!", &F);
+ uint16_t MutI = Attrs->getParamAttrs(0) & MutuallyIncompatible2;
+ Assert1(MutI != MutuallyIncompatible2, "Attributes" +
+ Attrs->getParamAttrsText(MutI) + "are incompatible!", &F);
for (FunctionType::param_iterator I = FT->param_begin(),
E = FT->param_end(); I != E; ++I, ++Idx) {
@@ -400,6 +406,10 @@
Assert1(!(MutI & (MutI - 1)), "Attributes " +
Attrs->getParamAttrsText(MutI) + "are incompatible!", &F);
+ uint16_t MutI2 = Attr & MutuallyIncompatible2;
+ Assert1(MutI2 != MutuallyIncompatible2, "Attributes" +
+ Attrs->getParamAttrsText(MutI2) + "are incompatible!", &F);
+
uint16_t IType = Attr & IntegerTypeOnly;
Assert1(!IType || FT->getParamType(Idx-1)->isInteger(),
"Attribute " + Attrs->getParamAttrsText(IType) +
More information about the llvm-commits
mailing list