summaryrefslogtreecommitdiffstats
path: root/ppapi
diff options
context:
space:
mode:
authorteravest@chromium.org <teravest@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2013-08-19 22:46:04 +0000
committerteravest@chromium.org <teravest@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2013-08-19 22:46:04 +0000
commit57a38e7979c652982ccd6106f50bbc30808a72b0 (patch)
tree4a5a297bcb71f92d161d00a233a6e567dc872b80 /ppapi
parent965ec7eaebb92437c3cc6a812da84af64bec8d68 (diff)
downloadchromium_src-57a38e7979c652982ccd6106f50bbc30808a72b0.zip
chromium_src-57a38e7979c652982ccd6106f50bbc30808a72b0.tar.gz
chromium_src-57a38e7979c652982ccd6106f50bbc30808a72b0.tar.bz2
Pepper: Improve PPB_File_Ref Create() comment.
When users create a FileRef for a path, the path must always begin with a "/" character. We require this for virtual paths, and users are not able to create FileRefs for external file systems. BUG= Review URL: https://chromiumcodereview.appspot.com/22819008 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@218354 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi')
-rw-r--r--ppapi/api/ppb_file_ref.idl2
-rw-r--r--ppapi/c/ppb_file_ref.h4
-rw-r--r--ppapi/cpp/file_ref.h2
3 files changed, 4 insertions, 4 deletions
diff --git a/ppapi/api/ppb_file_ref.idl b/ppapi/api/ppb_file_ref.idl
index 8e4b81d..d922647 100644
--- a/ppapi/api/ppb_file_ref.idl
+++ b/ppapi/api/ppb_file_ref.idl
@@ -25,7 +25,7 @@ interface PPB_FileRef {
*
* @param[in] resource A <code>PP_Resource</code> corresponding to a file
* system.
- * @param[in] path A path to the file.
+ * @param[in] path A path to the file. Must begin with a '/' character.
*
* @return A <code>PP_Resource</code> corresponding to a file reference if
* successful or 0 if the path is malformed.
diff --git a/ppapi/c/ppb_file_ref.h b/ppapi/c/ppb_file_ref.h
index 0f35e2c..873ef18 100644
--- a/ppapi/c/ppb_file_ref.h
+++ b/ppapi/c/ppb_file_ref.h
@@ -3,7 +3,7 @@
* found in the LICENSE file.
*/
-/* From ppb_file_ref.idl modified Wed May 22 15:08:49 2013. */
+/* From ppb_file_ref.idl modified Thu Aug 15 10:50:43 2013. */
#ifndef PPAPI_C_PPB_FILE_REF_H_
#define PPAPI_C_PPB_FILE_REF_H_
@@ -45,7 +45,7 @@ struct PPB_FileRef_1_1 {
*
* @param[in] resource A <code>PP_Resource</code> corresponding to a file
* system.
- * @param[in] path A path to the file.
+ * @param[in] path A path to the file. Must begin with a '/' character.
*
* @return A <code>PP_Resource</code> corresponding to a file reference if
* successful or 0 if the path is malformed.
diff --git a/ppapi/cpp/file_ref.h b/ppapi/cpp/file_ref.h
index d229c5f..56828f7 100644
--- a/ppapi/cpp/file_ref.h
+++ b/ppapi/cpp/file_ref.h
@@ -48,7 +48,7 @@ class FileRef : public Resource {
///
/// @param[in] file_system A <code>FileSystem</code> corresponding to a file
/// system type.
- /// @param[in] path A path to the file.
+ /// @param[in] path A path to the file. Must begin with a '/' character.
FileRef(const FileSystem& file_system, const char* path);
/// The copy constructor for <code>FileRef</code>.