OLD | NEW |
---|---|
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 /** | 6 /** |
7 * This file defines the API to create a file system associated with a file. | 7 * This file defines the API to create a file system associated with a file. |
8 */ | 8 */ |
9 | 9 |
10 label Chrome { | 10 label Chrome { |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
44 * Open() opens the file system. A file system must be opened before running | 44 * Open() opens the file system. A file system must be opened before running |
45 * any other operation on it. | 45 * any other operation on it. |
46 * | 46 * |
47 * @param[in] file_system A <code>PP_Resource</code> corresponding to a file | 47 * @param[in] file_system A <code>PP_Resource</code> corresponding to a file |
48 * system. | 48 * system. |
49 * @param[in] expected_size The expected size of the file system. | 49 * @param[in] expected_size The expected size of the file system. |
50 * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon | 50 * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon |
51 * completion of Open(). | 51 * completion of Open(). |
52 * | 52 * |
53 * @return An int32_t containing an error code from <code>pp_errors.h</code>. | 53 * @return An int32_t containing an error code from <code>pp_errors.h</code>. |
54 * | |
55 * TODO(brettw) clarify whether this must have completed before a file can | |
56 * be opened in it. Clarify what it means to be "completed." | |
57 */ | 54 */ |
55 | |
56 // TODO(brettw) clarify whether this must have completed before a file can | |
57 // be opened in it. Clarify what it means to be "completed." | |
dmichael (off chromium)
2012/02/15 17:53:50
Use C-style comments here ( /* ... */ )
jond
2012/02/15 22:33:53
Done.
| |
58 int32_t Open([in] PP_Resource file_system, | 58 int32_t Open([in] PP_Resource file_system, |
59 [in] int64_t expected_size, | 59 [in] int64_t expected_size, |
60 [in] PP_CompletionCallback callback); | 60 [in] PP_CompletionCallback callback); |
61 | 61 |
62 /** | 62 /** |
63 * GetType() returns the type of the provided file system. | 63 * GetType() returns the type of the provided file system. |
64 * | 64 * |
65 * @param[in] file_system A <code>PP_Resource</code> corresponding to a file | 65 * @param[in] file_system A <code>PP_Resource</code> corresponding to a file |
66 * system. | 66 * system. |
67 * | 67 * |
68 * @return A <code>PP_FileSystemType</code> with the file system type if | 68 * @return A <code>PP_FileSystemType</code> with the file system type if |
69 * valid or <code>PP_FILESYSTEMTYPE_INVALID</code> if the provided resource | 69 * valid or <code>PP_FILESYSTEMTYPE_INVALID</code> if the provided resource |
70 * is not a valid file system. It is valid to call this function even before | 70 * is not a valid file system. It is valid to call this function even before |
71 * Open() completes. | 71 * Open() completes. |
72 */ | 72 */ |
73 PP_FileSystemType GetType([in] PP_Resource file_system); | 73 PP_FileSystemType GetType([in] PP_Resource file_system); |
74 }; | 74 }; |
75 | 75 |
OLD | NEW |