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

Side by Side Diff: ppapi/c/ppb_file_system.h

Issue 9288006: Minor changes as per Christians most-recent review of the docs. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/
Patch Set: '' Created 8 years, 11 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 unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. 1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 * Use of this source code is governed by a BSD-style license that can be 2 * Use of this source code is governed by a BSD-style license that can be
3 * found in the LICENSE file. 3 * found in the LICENSE file.
4 */ 4 */
5 5
6 /* From ppb_file_system.idl modified Wed Oct 5 14:06:02 2011. */ 6 /* From ppb_file_system.idl modified Tue Jan 24 16:16:19 2012. */
7 7
8 #ifndef PPAPI_C_PPB_FILE_SYSTEM_H_ 8 #ifndef PPAPI_C_PPB_FILE_SYSTEM_H_
9 #define PPAPI_C_PPB_FILE_SYSTEM_H_ 9 #define PPAPI_C_PPB_FILE_SYSTEM_H_
10 10
11 #include "ppapi/c/pp_bool.h" 11 #include "ppapi/c/pp_bool.h"
12 #include "ppapi/c/pp_completion_callback.h" 12 #include "ppapi/c/pp_completion_callback.h"
13 #include "ppapi/c/pp_file_info.h" 13 #include "ppapi/c/pp_file_info.h"
14 #include "ppapi/c/pp_instance.h" 14 #include "ppapi/c/pp_instance.h"
15 #include "ppapi/c/pp_macros.h" 15 #include "ppapi/c/pp_macros.h"
16 #include "ppapi/c/pp_resource.h" 16 #include "ppapi/c/pp_resource.h"
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after
60 * Open() opens the file system. A file system must be opened before running 60 * Open() opens the file system. A file system must be opened before running
61 * any other operation on it. 61 * any other operation on it.
62 * 62 *
63 * @param[in] file_system A <code>PP_Resource</code> corresponding to a file 63 * @param[in] file_system A <code>PP_Resource</code> corresponding to a file
64 * system. 64 * system.
65 * @param[in] expected_size The expected size of the file system. 65 * @param[in] expected_size The expected size of the file system.
66 * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon 66 * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
67 * completion of Open(). 67 * completion of Open().
68 * 68 *
69 * @return An int32_t containing an error code from <code>pp_errors.h</code>. 69 * @return An int32_t containing an error code from <code>pp_errors.h</code>.
70 *
71 * TODO(brettw) clarify whether this must have completed before a file can
72 * be opened in it. Clarify what it means to be "completed."
73 */ 70 */
71 /* TODO(brettw) clarify whether this must have completed before a file can */
72 /* be opened in it. Clarify what it means to be "completed." */
74 int32_t (*Open)(PP_Resource file_system, 73 int32_t (*Open)(PP_Resource file_system,
75 int64_t expected_size, 74 int64_t expected_size,
76 struct PP_CompletionCallback callback); 75 struct PP_CompletionCallback callback);
77 /** 76 /**
78 * GetType() returns the type of the provided file system. 77 * GetType() returns the type of the provided file system.
79 * 78 *
80 * @param[in] file_system A <code>PP_Resource</code> corresponding to a file 79 * @param[in] file_system A <code>PP_Resource</code> corresponding to a file
81 * system. 80 * system.
82 * 81 *
83 * @return A <code>PP_FileSystemType</code> with the file system type if 82 * @return A <code>PP_FileSystemType</code> with the file system type if
84 * valid or <code>PP_FILESYSTEMTYPE_INVALID</code> if the provided resource 83 * valid or <code>PP_FILESYSTEMTYPE_INVALID</code> if the provided resource
85 * is not a valid file system. It is valid to call this function even before 84 * is not a valid file system. It is valid to call this function even before
86 * Open() completes. 85 * Open() completes.
87 */ 86 */
88 PP_FileSystemType (*GetType)(PP_Resource file_system); 87 PP_FileSystemType (*GetType)(PP_Resource file_system);
89 }; 88 };
90 89
91 typedef struct PPB_FileSystem_1_0 PPB_FileSystem; 90 typedef struct PPB_FileSystem_1_0 PPB_FileSystem;
92 /** 91 /**
93 * @} 92 * @}
94 */ 93 */
95 94
96 #endif /* PPAPI_C_PPB_FILE_SYSTEM_H_ */ 95 #endif /* PPAPI_C_PPB_FILE_SYSTEM_H_ */
97 96
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698