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

Unified Diff: ppapi/cpp/file_system.h

Issue 7307037: C++ File IO documentation. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/
Patch Set: Created 9 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
« ppapi/cpp/file_ref.h ('K') | « ppapi/cpp/file_ref.h ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: ppapi/cpp/file_system.h
===================================================================
--- ppapi/cpp/file_system.h (revision 91561)
+++ ppapi/cpp/file_system.h (working copy)
@@ -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 @@
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);
};
« ppapi/cpp/file_ref.h ('K') | « ppapi/cpp/file_ref.h ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698