Blame view

sources/3rdparty/php-cloudfiles/README 2.83 KB
03e52840d   Kload   Init
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
  ;; 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