mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
Add doc-comments to SIL Function and SILModule.
re: r3322 Swift SVN r3330
This commit is contained in:
@@ -31,6 +31,9 @@ namespace Lowering {
|
||||
class SILGenModule;
|
||||
}
|
||||
|
||||
/// Function - A function body that has been lowered to SIL. This consists of
|
||||
/// zero or more SIL BasicBlock objects that contain the Instruction objects
|
||||
/// making up the function.
|
||||
class Function : public SILAllocated<Function> {
|
||||
public:
|
||||
typedef llvm::iplist<BasicBlock> BlockListType;
|
||||
|
||||
@@ -30,10 +30,10 @@ namespace swift {
|
||||
class SILGenModule;
|
||||
}
|
||||
|
||||
/// SILModule - A SIL translation unit. The module object owns all of the SIL
|
||||
/// Function and other top-level objects generated when a translation unit is
|
||||
/// lowered to SIL.
|
||||
class SILModule : public SILBase {
|
||||
public:
|
||||
typedef llvm::iplist<BasicBlock> BlockListType;
|
||||
|
||||
private:
|
||||
friend class BasicBlock;
|
||||
friend class Function;
|
||||
|
||||
@@ -309,7 +309,7 @@ void BasicBlock::dump() const {
|
||||
print(llvm::errs());
|
||||
}
|
||||
|
||||
/// Pretty-print the BasicBlock with the designated stream.
|
||||
/// Pretty-print the BasicBlock to the designated stream.
|
||||
void BasicBlock::print(raw_ostream &OS) const {
|
||||
SILPrinter(OS).print(this);
|
||||
}
|
||||
@@ -319,7 +319,7 @@ void Function::dump() const {
|
||||
print(llvm::errs());
|
||||
}
|
||||
|
||||
/// Pretty-print the Function with the designated stream.
|
||||
/// Pretty-print the Function to the designated stream.
|
||||
void Function::print(llvm::raw_ostream &OS) const {
|
||||
SILPrinter Printer(OS);
|
||||
for (const BasicBlock &B : *this)
|
||||
@@ -331,7 +331,7 @@ void SILModule::dump() const {
|
||||
print(llvm::errs());
|
||||
}
|
||||
|
||||
/// Pretty-print the Function with the designated stream.
|
||||
/// Pretty-print the SILModule to the designated stream.
|
||||
void SILModule::print(llvm::raw_ostream &OS) const {
|
||||
for (ValueDecl *vd : functionDecls) {
|
||||
OS << "func_decl " << vd->getName() << '\n';
|
||||
|
||||
Reference in New Issue
Block a user