summaryrefslogtreecommitdiffstats
path: root/ppapi/c/ppb_file_io.h
diff options
context:
space:
mode:
authornoelallen@google.com <noelallen@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2011-08-17 20:45:57 +0000
committernoelallen@google.com <noelallen@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2011-08-17 20:45:57 +0000
commit49aa13876dd02aeea1b22443a127796c9a3bfebd (patch)
tree9a5a1ecc878359f21e5fe97a9bdc6ac94fdfae3c /ppapi/c/ppb_file_io.h
parent51e2f797693a966fca67779eb67475184be2c24d (diff)
downloadchromium_src-49aa13876dd02aeea1b22443a127796c9a3bfebd.zip
chromium_src-49aa13876dd02aeea1b22443a127796c9a3bfebd.tar.gz
chromium_src-49aa13876dd02aeea1b22443a127796c9a3bfebd.tar.bz2
Update placement of interface 'Define'
A minor change to the way we output the headers. This change moves the defines which are used to name the interfaces and thier versions to the top of the header, moving out of the @file block. This prevents them from being 'spewed' in the documentation. BUG= none TEST= none Review URL: http://codereview.chromium.org/7669001 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@97201 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/c/ppb_file_io.h')
-rw-r--r--ppapi/c/ppb_file_io.h15
1 files changed, 7 insertions, 8 deletions
diff --git a/ppapi/c/ppb_file_io.h b/ppapi/c/ppb_file_io.h
index ca23b95..928da63 100644
--- a/ppapi/c/ppb_file_io.h
+++ b/ppapi/c/ppb_file_io.h
@@ -17,6 +17,10 @@
#include "ppapi/c/pp_stdint.h"
#include "ppapi/c/pp_time.h"
+#define PPB_FILEIO_INTERFACE_0_5 "PPB_FileIO;0.5"
+#define PPB_FILEIO_INTERFACE_1_0 "PPB_FileIO;1.0"
+#define PPB_FILEIO_INTERFACE PPB_FILEIO_INTERFACE_1_0
+
/**
* @file
* This file defines the API to create a file i/o object.
@@ -70,10 +74,6 @@ PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_FileOpenFlags, 4);
* The <code>PPB_FileIO</code> struct is used to operate on a regular file
* (PP_FileType_Regular).
*/
-#define PPB_FILEIO_INTERFACE_0_5 "PPB_FileIO;0.5"
-#define PPB_FILEIO_INTERFACE_1_0 "PPB_FileIO;1.0"
-#define PPB_FILEIO_INTERFACE PPB_FILEIO_INTERFACE_1_0
-
struct PPB_FileIO {
/**
* Create() creates a new FileIO object.
@@ -164,7 +164,7 @@ struct PPB_FileIO {
* @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
* completion of Read().
*
- * @return An The number of bytes read or an error code from
+ * @return An The number of bytes read an error code from
* <code>pp_errors.h</code>. If the return value is 0, then end-of-file was
* reached. It is valid to call Read() multiple times with a completion
* callback to queue up parallel reads from the file at different offsets.
@@ -190,9 +190,7 @@ struct PPB_FileIO {
* @return An The number of bytes written or an error code from
* <code>pp_errors.h</code>. If the return value is 0, then end-of-file was
* reached. It is valid to call Write() multiple times with a completion
- * callback to queue up parallel writes to the file at different offsets. If
- * bytes_to_write is less than or equal to zero, return value is
- * PP_ERROR_FAILED.
+ * callback to queue up parallel writes to the file at different offsets.
*/
int32_t (*Write)(PP_Resource file_io,
int64_t offset,
@@ -245,3 +243,4 @@ struct PPB_FileIO {
*/
#endif /* PPAPI_C_PPB_FILE_IO_H_ */
+