trunk/branch integration: documentation

Foundation/include/Poco/ExpireCache.h

@@ -1,7 +1,7 @@
 //
 // ExpireCache.h
 //
-// $Id: //poco/svn/Foundation/include/Poco/ExpireCache.h#2 $
+// $Id: //poco/1.4/Foundation/include/Poco/ExpireCache.h#1 $
 //
 // Library: Foundation
 // Package: Cache
@@ -84,4 +84,4 @@ private:
 } // namespace Poco
 
 
-#endif
+#endif // Foundation_ExpireCache_INCLUDED

Foundation/include/Poco/ExpireLRUCache.h

@@ -1,7 +1,7 @@
 //
 // ExpireLRUCache.h
 //
-// $Id: //poco/svn/Foundation/include/Poco/ExpireLRUCache.h#2 $
+// $Id: //poco/1.4/Foundation/include/Poco/ExpireLRUCache.h#1 $
 //
 // Library: Foundation
 // Package: Cache
@@ -81,4 +81,4 @@ private:
 } // namespace Poco
 
 
-#endif
+#endif // Foundation_ExpireLRUCache_INCLUDED

Foundation/include/Poco/ExpireStrategy.h

@@ -1,7 +1,7 @@
 //
 // ExpireStrategy.h
 //
-// $Id: //poco/svn/Foundation/include/Poco/ExpireStrategy.h#3 $
+// $Id: //poco/1.4/Foundation/include/Poco/ExpireStrategy.h#1 $
 //
 // Library: Foundation
 // Package: Cache
@@ -149,4 +149,4 @@ protected:
 } // namespace Poco
 
 
-#endif
+#endif // Foundation_ExpireStrategy_INCLUDED

Foundation/include/Poco/FileStream_WIN32.h

@@ -61,8 +61,9 @@ public:
         void open(const std::string& path, std::ios::openmode mode);
                 /// Opens the given file in the given mode.
 
-	void close();
-		/// Closes the File stream buffer
+        bool close();
+                /// Closes the File stream buffer. Returns true if successful,
+                /// false otherwise.
 
         std::streampos seekoff(std::streamoff off, std::ios::seekdir dir, std::ios::openmode mode = std::ios::in | std::ios::out);
                 /// change position by offset, according to way and mode

Foundation/include/Poco/Format.h

@@ -1,7 +1,7 @@
 //
 // Format.h
 //
-// $Id: //poco/svn/Foundation/include/Poco/Format.h#2 $
+// $Id: //poco/1.4/Foundation/include/Poco/Format.h#1 $
 //
 // Library: Foundation
 // Package: Core
@@ -62,11 +62,14 @@ std::string Foundation_API format(const std::string& fmt, const Any& value);
         /// are copied verbatim to the result. A percent sign (%) marks the beginning
         /// of a format specification. Format specifications have the following syntax:
         ///
-	///   %[<flags>][<width>][.<precision>][<modifier>]<type>
+        ///   %[<index>][<flags>][<width>][.<precision>][<modifier>]<type>
         ///
-	/// Flags, width, precision and prefix are optional. The only required part of
+        /// Index, flags, width, precision and prefix are optional. The only required part of
         /// the format specification, apart from the percent sign, is the type.
         ///
+        /// The optional index argument has the format "[<n>]" and allows to
+        /// address an argument by its zero-based position (see the example below).
+        ///
         /// Following are valid type specifications and their meaning:
         ///
         ///   * b boolean (true = 1, false = 0)
@@ -86,7 +89,7 @@ std::string Foundation_API format(const std::string& fmt, const Any& value);
         /// The following flags are supported:
         ///
         ///   * - left align the result within the given field width
-	///   * + prefix the output value with a sign (+ or –) if the output value is of a signed type
+        ///   * + prefix the output value with a sign (+ or -) if the output value is of a signed type
         ///   * 0 if width is prefixed with 0, zeros are added until the minimum width is reached
         ///   * # For o, x, X, the # flag prefixes any nonzero output value with 0, 0x, or 0X, respectively; 
         ///     for e, E, f, the # flag forces the output value to contain a decimal point in all cases.
@@ -107,14 +110,16 @@ std::string Foundation_API format(const std::string& fmt, const Any& value);
         /// to be printed, the number of decimal places, or the number of significant digits.
         ///
         /// Throws a BadCastException if an argument does not correspond to the type of its format specification.
+        /// Throws an InvalidArgumentException if an argument index is out of range.
         /// 
         /// If there are more format specifiers than values, the format specifiers without a corresponding value
         /// are copied verbatim to output.
         ///
         /// If there are more values than format specifiers, the superfluous values are ignored.
         ///
-	/// Usage Example:
-	///     std::string s = format("The answer to life, the universe, and everything is %d", 42);
+        /// Usage Examples:
+        ///     std::string s1 = format("The answer to life, the universe, and everything is %d", 42);
+        ///     std::string s2 = format("second: %[1]d, first: %[0]d", 1, 2);
 
 std::string Foundation_API format(const std::string& fmt, const Any& value1, const Any& value2);
 std::string Foundation_API format(const std::string& fmt, const Any& value1, const Any& value2, const Any& value3);