C++ File IO documentation.

ppapi/cpp/file_ref.h

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef PPAPI_CPP_FILE_REF_H_
 #define PPAPI_CPP_FILE_REF_H_
 
 #include "ppapi/c/pp_stdint.h"
 #include "ppapi/c/ppb_file_ref.h"
 #include "ppapi/cpp/resource.h"
@@ skipping 12 matching lines @@
 /// a file system.
 class FileRef : public Resource {
  public:
   /// Default constructor for creating an is_null() <code>FileRef</code>
   /// object.
   FileRef() {}
 
  /// A constructor used to create a <code>FileRef</code> and associate it with
   /// the provided <code>Instance</code>.
   ///
-  /// @param[in] instance An <code>Instance</code>.
+  /// @param[in] resource An <code>Instance</code>.
   explicit FileRef(PP_Resource resource);
 
   /// A special structure used by the constructor that does not increment the
   /// reference count of the underlying file reference.
   struct PassRef {};
 
   /// A constructor used when you have received a PP_Resource as a return
   /// value that has already been reference counted.
   ///
   /// @param[in] resource A PP_Resource corresponding to file reference.
@@ skipping 41 matching lines @@
   /// @return A <code>FileRef</code> containing the parent directory of the
   /// file. This function fails if the file system type is
   /// <code>PP_FileSystemType_External</code>.
   FileRef GetParent() const;
 
   /// MakeDirectory() makes a new directory in the file system.  It is not
   /// valid to make a directory in the external file system.
   /// <strong>Note:</strong> Use MakeDirectoryIncludingAncestors() to create
   /// parent directories.
   ///
-  /// @param[in] callback A <code>CompletionCallback</code> to be called upon
+  /// @param[in] cc A <code>CompletionCallback</code> to be called upon
   /// completion of MakeDirectory().
   ///
   /// @return An int32_t containing an error code from <code>pp_errors.h</code>.
   /// Fails if the directory already exists.
   int32_t MakeDirectory(const CompletionCallback& cc);
 
   /// MakeDirectoryIncludingAncestors() makes a new directory in the file
   /// system as well as any parent directories. It is not valid to make a
   /// directory in the external file system.
   ///
-  /// @param[in] callback A <code>CompletionCallback</code> to be called upon
+  /// @param[in] cc A <code>CompletionCallback</code> to be called upon
   /// completion of MakeDirectoryIncludingAncestors().
   ///
   /// @return An int32_t containing an error code from <code>pp_errors.h</code>.
   /// Fails if the directory already exists.
   int32_t MakeDirectoryIncludingAncestors(const CompletionCallback& cc);
 
   /// Touch() Updates time stamps for a file.  You must have write access to the
   /// file if it exists in the external filesystem.
   ///
   /// @param[in] last_access_time The last time the file was accessed.
   /// @param[in] last_modified_time The last time the file was modified.
-  /// @param[in] callback A <code>CompletionCallback</code> to be called upon
+  /// @param[in] cc A <code>CompletionCallback</code> to be called upon
   /// completion of Touch().
   ///
   /// @return An int32_t containing an error code from <code>pp_errors.h</code>.
   int32_t Touch(PP_Time last_access_time,
                 PP_Time last_modified_time,
                 const CompletionCallback& cc);
 
   /// Delete() deletes a file or directory. If <code>file_ref</code> refers to
   /// a directory, then the directory must be empty. It is an error to delete a
   /// file or directory that is in use.  It is not valid to delete a file in
   /// the external file system.
   ///
-  /// @param[in] callback A <code>CompletionCallback</code> to be called upon
+  /// @param[in] cc A <code>CompletionCallback</code> to be called upon
   /// completion of Delete().
   ///
   /// @return An int32_t containing an error code from <code>pp_errors.h</code>.
   int32_t Delete(const CompletionCallback& cc);
 
   /// Rename() renames a file or directory. Argument <code>new_file_ref</code>
   /// must refer to files in the same file system as in this object. It is an
   /// error to rename a file or directory that is in use.  It is not valid to
   /// rename a file in the external file system.
   ///
   /// @param[in] new_file_ref A <code>FileRef</code> corresponding to a new
   /// file reference.
-  /// @param[in] callback A <code>CompletionCallback</code> to be called upon
+  /// @param[in] cc A <code>CompletionCallback</code> to be called upon
   /// completion of Rename().
   ///
   /// @return An int32_t containing an error code from <code>pp_errors.h</code>.
   int32_t Rename(const FileRef& new_file_ref, const CompletionCallback& cc);
 };
 
 }  // namespace pp
 
 #endif  // PPAPI_CPP_FILE_REF_H_