mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-08-17 05:29:24 +00:00
Fix minor doxygen nits.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@40854 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
parent
0713ca4255
commit
181b6c9cb5
@ -463,6 +463,8 @@ class Archive {
|
|||||||
/// into memory.
|
/// into memory.
|
||||||
Archive(const sys::Path& filename);
|
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
|
/// @param error Set to address of a std::string to get error messages
|
||||||
/// @returns false on error
|
/// @returns false on error
|
||||||
/// @brief Parse the symbol table at \p data.
|
/// @brief Parse the symbol table at \p data.
|
||||||
@ -476,17 +478,17 @@ class Archive {
|
|||||||
std::string* error ///< Optional error message catcher
|
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
|
/// @returns false on error
|
||||||
/// @brief Check that the archive signature is correct
|
/// @brief Check that the archive signature is correct
|
||||||
bool checkSignature(std::string* ErrMessage);
|
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
|
/// @returns false on error
|
||||||
/// @brief Load the entire archive.
|
/// @brief Load the entire archive.
|
||||||
bool loadArchive(std::string* ErrMessage);
|
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
|
/// @returns false on error
|
||||||
/// @brief Load just the symbol table.
|
/// @brief Load just the symbol table.
|
||||||
bool loadSymbolTable(std::string* ErrMessage);
|
bool loadSymbolTable(std::string* ErrMessage);
|
||||||
|
@ -240,7 +240,7 @@ namespace llvm {
|
|||||||
|
|
||||||
/// EmitString - Emit a string with quotes and a null terminator.
|
/// EmitString - Emit a string with quotes and a null terminator.
|
||||||
/// Special characters are emitted properly.
|
/// Special characters are emitted properly.
|
||||||
/// \literal (Eg. '\t') \endliteral
|
/// @verbatim (Eg. '\t') @endverbatim
|
||||||
void EmitString(const std::string &String) const;
|
void EmitString(const std::string &String) const;
|
||||||
|
|
||||||
//===------------------------------------------------------------------===//
|
//===------------------------------------------------------------------===//
|
||||||
|
@ -311,7 +311,9 @@ public:
|
|||||||
bool isString() const;
|
bool isString() const;
|
||||||
|
|
||||||
/// isCString - This method returns true if the array is a string (see
|
/// 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
|
/// isString) and it ends in a null byte \0 and does not contains any other
|
||||||
|
/// @endverbatim
|
||||||
/// null bytes except its terminator.
|
/// null bytes except its terminator.
|
||||||
bool isCString() const;
|
bool isCString() const;
|
||||||
|
|
||||||
|
@ -204,7 +204,7 @@ class Linker {
|
|||||||
/// found in one library, based on the unresolved symbols in the composite
|
/// 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
|
/// 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
|
/// 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
|
/// LinkInArchive method. If an error occurs, the Linker's error string is
|
||||||
/// set.
|
/// set.
|
||||||
/// @see LinkInArchive
|
/// @see LinkInArchive
|
||||||
|
@ -89,7 +89,7 @@ public:
|
|||||||
return Insert(new ReturnInst());
|
return Insert(new ReturnInst());
|
||||||
}
|
}
|
||||||
|
|
||||||
/// CreateRet - Create a 'ret <val>' instruction.
|
/// @verbatim CreateRet - Create a 'ret <val>' instruction. @endverbatim
|
||||||
ReturnInst *CreateRet(Value *V) {
|
ReturnInst *CreateRet(Value *V) {
|
||||||
return Insert(new ReturnInst(V));
|
return Insert(new ReturnInst(V));
|
||||||
}
|
}
|
||||||
|
@ -71,7 +71,7 @@ public:
|
|||||||
void setUseQuotes(bool Val) { UseQuotes = Val; }
|
void setUseQuotes(bool Val) { UseQuotes = Val; }
|
||||||
|
|
||||||
/// setPreserveAsmNames - If the mangler should not strip off the asm name
|
/// 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; }
|
void setPreserveAsmNames(bool Val) { PreserveAsmNames = Val; }
|
||||||
|
|
||||||
/// Acceptable Characters - This allows the target to specify which characters
|
/// Acceptable Characters - This allows the target to specify which characters
|
||||||
|
@ -23,7 +23,7 @@ namespace llvm {
|
|||||||
/// of memory, and provides simple methods for reading files and standard input
|
/// 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
|
/// 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
|
/// 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 {
|
class MemoryBuffer {
|
||||||
const char *BufferStart; // Start of the buffer.
|
const char *BufferStart; // Start of the buffer.
|
||||||
const char *BufferEnd; // End of the buffer.
|
const char *BufferEnd; // End of the buffer.
|
||||||
|
@ -21,8 +21,8 @@ namespace llvm {
|
|||||||
|
|
||||||
/// BaseStream - Acts like the STL streams. It's a wrapper for the std::cerr,
|
/// 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
|
/// 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
|
/// @verbatim <iostream> @endverbatm in every file (doing so increases static
|
||||||
/// object code).
|
/// c'tors & d'tors in the object code).
|
||||||
///
|
///
|
||||||
template <typename StreamTy>
|
template <typename StreamTy>
|
||||||
class BaseStream {
|
class BaseStream {
|
||||||
|
@ -177,7 +177,8 @@ namespace sys {
|
|||||||
/// This constructor will accept a character range as a path. No checking
|
/// 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
|
/// is done on this path to determine if it is valid. To determine
|
||||||
/// validity of the path, use the isValid method.
|
/// 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.
|
/// @brief Construct a Path from a string.
|
||||||
explicit Path(const char *StrStart, unsigned StrLen)
|
explicit Path(const char *StrStart, unsigned StrLen)
|
||||||
: path(StrStart, StrStart+StrLen) {}
|
: path(StrStart, StrStart+StrLen) {}
|
||||||
@ -280,7 +281,7 @@ namespace sys {
|
|||||||
|
|
||||||
/// This function determines if the path name is absolute, as opposed to
|
/// This function determines if the path name is absolute, as opposed to
|
||||||
/// relative.
|
/// relative.
|
||||||
/// @breif Determine if the path is absolute.
|
/// @brief Determine if the path is absolute.
|
||||||
bool isAbsolute() const;
|
bool isAbsolute() const;
|
||||||
|
|
||||||
/// This function opens the file associated with the path name provided by
|
/// This function opens the file associated with the path name provided by
|
||||||
@ -512,6 +513,7 @@ namespace sys {
|
|||||||
/// directory, recursively. If the Path refers to a file, the
|
/// directory, recursively. If the Path refers to a file, the
|
||||||
/// \p destroy_contents parameter is ignored.
|
/// \p destroy_contents parameter is ignored.
|
||||||
/// @param destroy_contents Indicates whether the contents of a destroyed
|
/// @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).
|
/// directory should also be destroyed (recursively).
|
||||||
/// @returns false if the file/directory was destroyed, true on error.
|
/// @returns false if the file/directory was destroyed, true on error.
|
||||||
/// @brief Removes the file or directory from the filesystem.
|
/// @brief Removes the file or directory from the filesystem.
|
||||||
@ -554,18 +556,19 @@ namespace sys {
|
|||||||
/// This constructor will accept a std::string as a path. No checking is
|
/// 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
|
/// done on this path to determine if it is valid. To determine validity
|
||||||
/// of the path, use the isValid method.
|
/// of the path, use the isValid method.
|
||||||
/// @param p The path to assign.
|
|
||||||
/// @brief Construct a Path from a string.
|
/// @brief Construct a Path from a string.
|
||||||
explicit PathWithStatus(const std::string& p)
|
explicit PathWithStatus(
|
||||||
: Path(p), status(), fsIsValid(false) {}
|
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
|
/// 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
|
/// is done on this path to determine if it is valid. To determine
|
||||||
/// validity of the path, use the isValid method.
|
/// validity of the path, use the isValid method.
|
||||||
/// @param p The path to assign.
|
|
||||||
/// @brief Construct a Path from a string.
|
/// @brief Construct a Path from a string.
|
||||||
explicit PathWithStatus(const char *StrStart, unsigned StrLen)
|
explicit PathWithStatus(
|
||||||
: Path(StrStart, StrLen), status(), fsIsValid(false) {}
|
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.
|
/// Makes a copy of \p that to \p this.
|
||||||
/// @returns \p this
|
/// @returns \p this
|
||||||
|
@ -104,7 +104,7 @@ namespace llvm {
|
|||||||
/// will enclose any GlobalVariable that points to a function.
|
/// will enclose any GlobalVariable that points to a function.
|
||||||
/// For example, this is used by the IA64 backend to materialize
|
/// For example, this is used by the IA64 backend to materialize
|
||||||
/// function descriptors, by decorating the ".data8" object with the
|
/// function descriptors, by decorating the ".data8" object with the
|
||||||
/// \literal @fptr( ) \endliteral
|
/// @verbatim @fptr( ) @endverbatim
|
||||||
/// link-relocation operator.
|
/// link-relocation operator.
|
||||||
///
|
///
|
||||||
const char *FunctionAddrPrefix; // Defaults to ""
|
const char *FunctionAddrPrefix; // Defaults to ""
|
||||||
@ -190,7 +190,7 @@ namespace llvm {
|
|||||||
const char *JumpTableDirective;
|
const char *JumpTableDirective;
|
||||||
|
|
||||||
/// CStringSection - If not null, this allows for special handling of
|
/// 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
|
/// other null bytes) on this target. This is commonly supported as
|
||||||
/// ".cstring".
|
/// ".cstring".
|
||||||
const char *CStringSection; // Defaults to NULL
|
const char *CStringSection; // Defaults to NULL
|
||||||
@ -230,8 +230,8 @@ namespace llvm {
|
|||||||
/// LCOMMDirective - This is the name of a directive (if supported) that can
|
/// LCOMMDirective - This is the name of a directive (if supported) that can
|
||||||
/// be used to efficiently declare a local (internal) block of zero
|
/// be used to efficiently declare a local (internal) block of zero
|
||||||
/// initialized data in the .bss/.data section. The syntax expected is:
|
/// initialized data in the .bss/.data section. The syntax expected is:
|
||||||
/// \literal <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
|
/// @verbatim <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
|
||||||
/// \endliteral
|
/// @endverbatim
|
||||||
const char *LCOMMDirective; // Defaults to null.
|
const char *LCOMMDirective; // Defaults to null.
|
||||||
|
|
||||||
const char *COMMDirective; // Defaults to "\t.comm\t".
|
const char *COMMDirective; // Defaults to "\t.comm\t".
|
||||||
|
@ -58,9 +58,9 @@ class DIEValue;
|
|||||||
|
|
||||||
//===----------------------------------------------------------------------===//
|
//===----------------------------------------------------------------------===//
|
||||||
/// DWLabel - Labels are used to track locations in the assembler file.
|
/// DWLabel - Labels are used to track locations in the assembler file.
|
||||||
/// Labels appear in the form <prefix><Tag><Number>, where the tag is a
|
/// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
|
||||||
/// category of label (Ex. location) and number is a value unique in that
|
/// where the tag is a category of label (Ex. location) and number is a value
|
||||||
/// category.
|
/// unique in that category.
|
||||||
class DWLabel {
|
class DWLabel {
|
||||||
public:
|
public:
|
||||||
/// Tag - Label category tag. Should always be a staticly declared C string.
|
/// Tag - Label category tag. Should always be a staticly declared C string.
|
||||||
|
@ -146,10 +146,10 @@ const TargetAlignElem TargetData::InvalidAlignmentElem =
|
|||||||
<i>[E|e]</i>: Endianness. "E" specifies a big-endian target data model, "e"
|
<i>[E|e]</i>: Endianness. "E" specifies a big-endian target data model, "e"
|
||||||
specifies a little-endian target data model.
|
specifies a little-endian target data model.
|
||||||
<br><br>
|
<br><br>
|
||||||
<i>p:<size>:<abi_align>:<pref_align></i>: Pointer size, ABI and preferred
|
<i>p:@verbatim<size>:<abi_align>:<pref_align>@endverbatim</i>: Pointer size,
|
||||||
alignment.
|
ABI and preferred alignment.
|
||||||
<br><br>
|
<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
|
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.
|
packed) or aggregate. Size indicates the size, e.g., 32 or 64 bits.
|
||||||
\p
|
\p
|
||||||
|
@ -370,6 +370,9 @@ void Verifier::visitFunction(Function &F) {
|
|||||||
ParamAttr::ByVal | ParamAttr::InReg |
|
ParamAttr::ByVal | ParamAttr::InReg |
|
||||||
ParamAttr::Nest | ParamAttr::StructRet;
|
ParamAttr::Nest | ParamAttr::StructRet;
|
||||||
|
|
||||||
|
const uint16_t MutuallyIncompatible2 =
|
||||||
|
ParamAttr::ZExt | ParamAttr::SExt;
|
||||||
|
|
||||||
const uint16_t IntegerTypeOnly =
|
const uint16_t IntegerTypeOnly =
|
||||||
ParamAttr::SExt | ParamAttr::ZExt;
|
ParamAttr::SExt | ParamAttr::ZExt;
|
||||||
|
|
||||||
@ -386,6 +389,9 @@ void Verifier::visitFunction(Function &F) {
|
|||||||
uint16_t RetI = Attrs->getParamAttrs(0) & ReturnIncompatible;
|
uint16_t RetI = Attrs->getParamAttrs(0) & ReturnIncompatible;
|
||||||
Assert1(!RetI, "Attribute " + Attrs->getParamAttrsText(RetI) +
|
Assert1(!RetI, "Attribute " + Attrs->getParamAttrsText(RetI) +
|
||||||
"should not apply to functions!", &F);
|
"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(),
|
for (FunctionType::param_iterator I = FT->param_begin(),
|
||||||
E = FT->param_end(); I != E; ++I, ++Idx) {
|
E = FT->param_end(); I != E; ++I, ++Idx) {
|
||||||
@ -400,6 +406,10 @@ void Verifier::visitFunction(Function &F) {
|
|||||||
Assert1(!(MutI & (MutI - 1)), "Attributes " +
|
Assert1(!(MutI & (MutI - 1)), "Attributes " +
|
||||||
Attrs->getParamAttrsText(MutI) + "are incompatible!", &F);
|
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;
|
uint16_t IType = Attr & IntegerTypeOnly;
|
||||||
Assert1(!IType || FT->getParamType(Idx-1)->isInteger(),
|
Assert1(!IType || FT->getParamType(Idx-1)->isInteger(),
|
||||||
"Attribute " + Attrs->getParamAttrsText(IType) +
|
"Attribute " + Attrs->getParamAttrsText(IType) +
|
||||||
|
Loading…
Reference in New Issue
Block a user