Fix a bunch of -Wdocumentation warnings.

[oota-llvm.git] / include / llvm / Support / FormattedStream.h

diff --git a/include/llvm/Support/FormattedStream.h b/include/llvm/Support/FormattedStream.h
index 768b8ed0eed9ff65d9da5cd23b9a85b024ed50ab..58a18851687ca2b7732f43af1d68b0ef0b4af11f 100644 (file)
--- a/include/llvm/Support/FormattedStream.h
+++ b/include/llvm/Support/FormattedStream.h
@@ -1,4 +1,4 @@
-//===-- llvm/CodeGen/FormattedStream.h - Formatted streams ------*- C++ -*-===//
+//===-- llvm/Support/FormattedStream.h - Formatted streams ------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
@@ -26,12 +26,12 @@ namespace llvm
   public:
     /// DELETE_STREAM - Tell the destructor to delete the held stream.
     ///
-    const static bool DELETE_STREAM = true;
+    static const bool DELETE_STREAM = true;
 
     /// PRESERVE_STREAM - Tell the destructor to not delete the held
     /// stream.
     ///
-    const static bool PRESERVE_STREAM = false;
+    static const bool PRESERVE_STREAM = false;
 
   private:
     /// TheStream - The real stream we output to. We set it to be
@@ -59,7 +59,7 @@ namespace llvm
 
     /// current_pos - Return the current position within the stream,
     /// not counting the bytes currently in the buffer.
-    virtual uint64_t current_pos() { 
+    virtual uint64_t current_pos() const { 
       // This has the same effect as calling TheStream.current_pos(),
       // but that interface is private.
       return TheStream->tell() - TheStream->GetNumBytesInBuffer();
@@ -119,7 +119,7 @@ namespace llvm
     /// space.
     ///
     /// \param NewCol - The column to move to.
-    void PadToColumn(unsigned NewCol);
+    formatted_raw_ostream &PadToColumn(unsigned NewCol);
 
   private:
     void releaseStream() {
@@ -144,6 +144,10 @@ formatted_raw_ostream &fouts();
 /// standard error.  Use it like: ferrs() << "foo" << "bar";
 formatted_raw_ostream &ferrs();
 
+/// fdbgs() - This returns a reference to a formatted_raw_ostream for
+/// debug output.  Use it like: fdbgs() << "foo" << "bar";
+formatted_raw_ostream &fdbgs();
+
 } // end llvm namespace