74 lines
2.8 KiB
Plaintext
74 lines
2.8 KiB
Plaintext
;; PHP Cloud Files API
|
|
;; ========================================================================
|
|
;; This package contains the PHP API for the Cloud Files storage system.
|
|
;;
|
|
;; Please see http://www.rackspacecloud.com/ for more information regarding the
|
|
;; Cloud Files storage system.
|
|
;;
|
|
;; Install
|
|
;; ------------------------------------------------------------------------
|
|
;; Extract this archive and make sure the source code files are in your
|
|
;; PHP "include path". To use the API in your source code, just make
|
|
;; sure to include/require the "cloudfiles.php" script.
|
|
;;
|
|
;; Requirements
|
|
;; ------------------------------------------------------------------------
|
|
;; [mandatory] PHP version 5.x (developed against 5.2.0)
|
|
;; [mandatory] PHP's cURL module
|
|
;; [mandatory] PHP enabled with mbstring (multi-byte string) support
|
|
;; [suggested] PEAR FileInfo module (for Content-Type detection)
|
|
;;
|
|
;; Examples
|
|
;; ------------------------------------------------------------------------
|
|
;; For sample code, please see the tests and API docs.
|
|
;;
|
|
;; Docs
|
|
;; ------------------------------------------------------------------------
|
|
;; The included documentation was generated directly from the source
|
|
;; code files using the PHPDocumentor tool.
|
|
;;
|
|
;; This README file is actually the PHPDocumentor INI configuration file.
|
|
;; The following packages were installed via PEAR to generate the HTML
|
|
;; API documentation.
|
|
;;
|
|
;; * PEAR 1.4.11 (stable)
|
|
;; * PhpDocumentor 1.4.2 (stable)
|
|
;; * XML_Beautifier 1.2.0 (stable)
|
|
;; * XML_Parser 1.3.1 (stable)
|
|
;; * XML_Util 1.2.0 (stable)
|
|
;;
|
|
;; To re-generate the API docs, make sure the above software is
|
|
;; available and run:
|
|
;; rm -rf docs && phpdoc -c phpdoc.ini
|
|
;;
|
|
;; Tests
|
|
;; ------------------------------------------------------------------------
|
|
;; The tests are based on phpunit and are run with PHPUnit 3.3.17
|
|
;; please follow the instructions on :
|
|
;;
|
|
;; http://www.phpunit.de/manual/current/en/installation.html
|
|
;;
|
|
;; to install PHPUnit. When installed just run the command phpunit on
|
|
;; the top of the directory and it will launch the tests.
|
|
;;
|
|
;; The tests/Comprehensive.php is not enabled by default since
|
|
;; generating big files. If you want to run it you need to go in the
|
|
;; tests directory and run with phpunit Comprehensive.php
|
|
;;
|
|
;; ========================================================================
|
|
;; The lines below here are the configuration settings for re-generating
|
|
;; the PHP API documentation.
|
|
;;
|
|
[Parse Data]
|
|
title = php-cloudfiles
|
|
hidden = false
|
|
parseprivate = off
|
|
javadocdesc = off
|
|
defaultpackagename = php-cloudfiles
|
|
defaultcategoryname = php-cloudfiles
|
|
target = docs
|
|
directory = .
|
|
ignore = share/,examples/,tests/,.git/,.gitignore,*.ini,*.swp
|
|
output=HTML:Smarty:PHP
|
|
readmeinstallchangelog = README,COPYING,AUTHORS,Changelog
|