Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(476)

Unified Diff: src/IceGlobalInits.h

Issue 1216963007: Doxygenize the documentation comments (Closed) Base URL: https://chromium.googlesource.com/native_client/pnacl-subzero.git@master
Patch Set: Rebase to master Created 5 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « src/IceGlobalContext.cpp ('k') | src/IceGlobalInits.cpp » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: src/IceGlobalInits.h
diff --git a/src/IceGlobalInits.h b/src/IceGlobalInits.h
index 08f4fe3afcc24e8c4ba00b226d094fe8a1fdb544..fb86f7cd4748de4a48eaab7c1e4a3a6d6311715e 100644
--- a/src/IceGlobalInits.h
+++ b/src/IceGlobalInits.h
@@ -6,12 +6,13 @@
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
-//
-// This file declares the representation of function declarations,
-// global variable declarations, and the corresponding variable
-// initializers in Subzero. Global variable initializers are
-// represented as a sequence of simple initializers.
-//
+///
+/// \file
+/// This file declares the representation of function declarations,
+/// global variable declarations, and the corresponding variable
+/// initializers in Subzero. Global variable initializers are
+/// represented as a sequence of simple initializers.
+///
//===----------------------------------------------------------------------===//
#ifndef SUBZERO_SRC_ICEGLOBALINITS_H
@@ -79,8 +80,8 @@ public:
/// Returns true if when emitting names, we should suppress mangling.
virtual bool getSuppressMangling() const = 0;
- // Mangles name for cross tests, unless external and not defined locally
- // (so that relocations accross pnacl-sz and pnacl-llc will work).
+ /// Mangles name for cross tests, unless external and not defined locally
+ /// (so that relocations accross pnacl-sz and pnacl-llc will work).
virtual IceString mangleName(GlobalContext *Ctx) const {
return getSuppressMangling() ? Name : Ctx->mangleName(Name);
}
@@ -95,8 +96,8 @@ protected:
llvm::GlobalValue::LinkageTypes Linkage;
};
-// Models a function declaration. This includes the type signature of
-// the function, its calling conventions, and its linkage.
+/// Models a function declaration. This includes the type signature of
+/// the function, its calling conventions, and its linkage.
class FunctionDeclaration : public GlobalDeclaration {
FunctionDeclaration() = delete;
FunctionDeclaration(const FunctionDeclaration &) = delete;
@@ -113,7 +114,7 @@ public:
}
const FuncSigType &getSignature() const { return Signature; }
llvm::CallingConv::ID getCallingConv() const { return CallingConv; }
- // isProto implies that there isn't a (local) definition for the function.
+ /// isProto implies that there isn't a (local) definition for the function.
bool isProto() const { return IsProto; }
static bool classof(const GlobalDeclaration *Addr) {
return Addr->getKind() == FunctionDeclarationKind;
@@ -169,7 +170,7 @@ public:
const InitializerKind Kind;
};
- // Models the data in a data initializer.
+ /// Models the data in a data initializer.
typedef std::vector<char> DataVecType;
/// Defines a sequence of byte values as a data initializer.
@@ -205,7 +206,7 @@ public:
Contents[i] = Str[i];
}
- // The byte contents of the data initializer.
+ /// The byte contents of the data initializer.
DataVecType Contents;
};
@@ -230,7 +231,7 @@ public:
explicit ZeroInitializer(SizeT Size)
: Initializer(ZeroInitializerKind), Size(Size) {}
- // The number of bytes to be zero initialized.
+ /// The number of bytes to be zero initialized.
SizeT Size;
};
@@ -262,7 +263,7 @@ public:
Offset(Offset) {} // The global declaration used in the relocation.
const GlobalDeclaration *Declaration;
- // The offset to add to the relocation.
+ /// The offset to add to the relocation.
const RelocOffsetT Offset;
};
@@ -324,14 +325,14 @@ public:
void discardInitializers() { Initializers = nullptr; }
private:
- // list of initializers for the declared variable.
+ /// List of initializers for the declared variable.
std::unique_ptr<InitializerListType> Initializers;
bool HasInitializer;
- // The alignment of the declared variable.
+ /// The alignment of the declared variable.
uint32_t Alignment;
- // True if a declared (global) constant.
+ /// True if a declared (global) constant.
bool IsConstant;
- // If set to true, force getSuppressMangling() to return true.
+ /// If set to true, force getSuppressMangling() to return true.
bool ForceSuppressMangling;
VariableDeclaration()
« no previous file with comments | « src/IceGlobalContext.cpp ('k') | src/IceGlobalInits.cpp » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698