diff options
author | webchick <webchick@24967.no-reply.drupal.org> | 2012-01-21 09:15:15 -0800 |
---|---|---|
committer | webchick <webchick@24967.no-reply.drupal.org> | 2012-01-21 09:15:15 -0800 |
commit | 767d72d48ec1b641193a072a114d0cd1ca44faf0 (patch) | |
tree | a21f37b196ba52e27b13072cec800ee8f07d37c9 /includes/archiver.inc | |
parent | 8ef9e8aa6e1ffa368188c42118cae36ccb507264 (diff) | |
download | brdo-767d72d48ec1b641193a072a114d0cd1ca44faf0.tar.gz brdo-767d72d48ec1b641193a072a114d0cd1ca44faf0.tar.bz2 |
Issue #1315886 by xjm, jhodgdon: Clean up API docs for includes directory, files starting with A-C.
Diffstat (limited to 'includes/archiver.inc')
-rw-r--r-- | includes/archiver.inc | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/includes/archiver.inc b/includes/archiver.inc index fec053be6..2db2db15a 100644 --- a/includes/archiver.inc +++ b/includes/archiver.inc @@ -6,43 +6,45 @@ */ /** - * Common interface for all Archiver classes. + * Defines the common interface for all Archiver classes. */ interface ArchiverInterface { /** - * Constructor for a new archiver instance. + * Constructs a new archiver instance. * * @param $file_path - * The full system path of the archive to manipulate. Only local files - * are supported. If the file does not yet exist, it will be created if + * The full system path of the archive to manipulate. Only local files + * are supported. If the file does not yet exist, it will be created if * appropriate. */ public function __construct($file_path); /** - * Add the specified file or directory to the archive. + * Adds the specified file or directory to the archive. * * @param $file_path * The full system path of the file or directory to add. Only local files * and directories are supported. + * * @return ArchiverInterface * The called object. */ public function add($file_path); /** - * Remove the specified file from the archive. + * Removes the specified file from the archive. * * @param $path * The file name relative to the root of the archive to remove. + * * @return ArchiverInterface * The called object. */ public function remove($path); /** - * Extract multiple files in the archive to the specified path. + * Extracts multiple files in the archive to the specified path. * * @param $path * A full system path of the directory to which to extract files. @@ -50,13 +52,14 @@ interface ArchiverInterface { * Optionally specify a list of files to be extracted. Files are * relative to the root of the archive. If not specified, all files * in the archive will be extracted + * * @return ArchiverInterface * The called object. */ public function extract($path, Array $files = array()); /** - * List all files in the archive. + * Lists all files in the archive. * * @return * An array of file names relative to the root of the archive. |