C++ File IO documentation. This is more-or-less a copy and paste from the C docs.

Review URL: http://codereview.chromium.org/7307037

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@91876 0039d316-1c4b-4281-b951-d872f2087c98

1 files changed, 20 insertions, 1 deletions

diff --git a/ppapi/cpp/file_system.h b/ppapi/cpp/file_system.h
index f5beb66..be730b6 100644
--- a/ppapi/cpp/file_system.h
+++ b/ppapi/cpp/file_system.h
@@ -12,6 +12,9 @@
 #include "ppapi/cpp/instance.h"
 #include "ppapi/cpp/resource.h"
 
+/// @file
+/// This file defines the API to create a file system associated with a file.
+
 struct PP_FileInfo;
 
 namespace pp {
@@ -19,11 +22,27 @@ namespace pp {
 class CompletionCallback;
 class FileRef;
 
-// Wraps methods from ppb_file_system.h
+/// The <code>FileSystem</code> class identifies the file system type
+/// associated with a file.
 class FileSystem : public Resource {
  public:
+
+  /// This constructor creates a file system object of the given type.
+  ///
+  /// @param[in] instance A <code>Instance</code> indentifying the instance
+  /// with the file.
+  /// @param[in] type A file system type as defined by
+  /// <code>PP_FileSystemType</code> enum.
   FileSystem(Instance* instance, PP_FileSystemType type);
 
+  /// Open() opens the file system. A file system must be opened before running
+  /// any other operation on it.
+  ///
+  /// @param[in] expected_size The expected size of the file system.
+  /// @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
+  /// completion of Open().
+  ///
+  /// @return An int32_t containing an error code from <code>pp_errors.h</code>.
   int32_t Open(int64_t expected_size, const CompletionCallback& cc);
 };