From b871dd7f1c2449503dfefed385a8738b158dcf3d Mon Sep 17 00:00:00 2001 From: Mikael Roos Date: Wed, 2 Dec 2015 11:05:41 +0100 Subject: [PATCH] update docs/api with phpdoc --- docs/api/classes/CAsciiArt.html | 731 +++++++++++ docs/api/classes/CHttpGet.html | 74 +- docs/api/classes/CImage.html | 1038 +++++++++++++-- docs/api/classes/CRemoteImage.html | 110 +- docs/api/classes/CWhitelist.html | 17 +- docs/api/files/CAsciiArt.html | 257 ++++ docs/api/files/CAsciiArt.php.txt | 213 +++ docs/api/files/CHttpGet.html | 13 +- docs/api/files/CHttpGet.php.txt | 54 +- docs/api/files/CImage.html | 13 +- docs/api/files/CImage.php.txt | 565 ++++++-- docs/api/files/CRemoteImage.html | 13 +- docs/api/files/CRemoteImage.php.txt | 101 +- docs/api/files/CWhitelist.html | 13 +- docs/api/files/CWhitelist.php.txt | 14 +- docs/api/files/autoload.html | 13 +- docs/api/files/autoload.php.txt | 2 +- docs/api/files/webroot.img.html | 15 +- docs/api/files/webroot.img_config.html | 13 +- docs/api/files/webroot/img.php.txt | 1167 +++++++++++++++++ docs/api/files/webroot/img_config.php.txt | 386 ++++++ docs/api/graphs/class.html | 6 +- docs/api/graphs/classes.svg | 29 +- docs/api/index.html | 19 +- docs/api/namespaces/default.html | 19 +- ...-file_5de178c5dafcaff40d31e6fe8bec9eea.dat | Bin 44103 -> 48283 bytes ...-file_58c9e20d7971fb3461feadcf8052d7c6.dat | Bin 39662 -> 34882 bytes ...-file_05104b5f33216f058e4b600e59ccee4e.dat | Bin 253004 -> 297123 bytes ...-file_ace2bb5eac6f81a3a5d8d5eeb2b59685.dat | Bin 0 -> 33990 bytes ...-file_73f6e60ef59c0c30ffc560b4da7243ca.dat | Bin 13903 -> 13188 bytes ...-file_2c624667a65767f32365565ca6d89fea.dat | Bin 30835 -> 36436 bytes ...-file_ec58a87628ba00fb2321bc6cdb7d54b4.dat | Bin 10977 -> 11016 bytes ...-file_83ad6bd4885732fd14b9d8709d592efd.dat | Bin 3176 -> 2758 bytes docs/api/reports/deprecated.html | 6 +- docs/api/reports/errors.html | 161 ++- docs/api/reports/markers.html | 920 +------------ 36 files changed, 4492 insertions(+), 1490 deletions(-) create mode 100644 docs/api/classes/CAsciiArt.html create mode 100644 docs/api/files/CAsciiArt.html create mode 100644 docs/api/files/CAsciiArt.php.txt create mode 100644 docs/api/files/webroot/img.php.txt create mode 100644 docs/api/files/webroot/img_config.php.txt create mode 100644 docs/api/phpdoc-cache-aa/phpdoc-cache-file_ace2bb5eac6f81a3a5d8d5eeb2b59685.dat diff --git a/docs/api/classes/CAsciiArt.html b/docs/api/classes/CAsciiArt.html new file mode 100644 index 0000000..17073e8 --- /dev/null +++ b/docs/api/classes/CAsciiArt.html @@ -0,0 +1,731 @@ + + + + + + CImage API Documentaion + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + CImage API Documentaion + +
+ +
+
+
+ + + +
+ +
+
+
+
+
+
+ + \ +
+
+
+ + + +
+
+
+
+ +
+
+
+
+
+
+ + + +

\CAsciiArt

+

Create an ASCII version of an image.

+ + + +
+

Summary

+
+
+ Methods +
+
+ Properties +
+
+ Constants +
+
+
+
+ __construct()
+ addCharacterSet()
+ setOptions()
+ createFromFile()
+ luminanceAreaAverage()
+ getLuminance()
+ luminance2character()
+
+
+ No public properties found +
+
+ No constants found +
+
+
+
+ No protected methods found +
+
+ No protected properties found +
+
+ N/A +
+
+
+
+ No private methods found +
+
+ $characterSet
+ $characters
+ $charCount
+ $scale
+ $luminanceStrategy
+
+
+ N/A +
+
+
+
+ +
+ + + +
+
+

Properties

+
+ +
+ +
+
+ +
+

$characterSet

+ 
$characterSet :
+

Character set to use.

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$characters

+ 
$characters :
+

Current character set.

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$charCount

+ 
$charCount :
+

Length of current character set.

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$scale

+ 
$scale :
+

Scale of the area to swap to a character.

+ + +

Type

+ +
+
+ +
+ +
+
+ +
+

$luminanceStrategy

+ 
$luminanceStrategy :
+

Strategy to calculate luminance.

+ + +

Type

+ +
+
+ +
+ + + +
+

Methods

+ +
+ +
+
+ +
+

__construct()

+ + 
__construct()
+

Constructor which sets default options.

+ + + + + +
+
+ +
+ +
+
+ +
+

addCharacterSet()

+ + 
addCharacterSet(string  $key, string  $value) : $this
+

Add a custom character set.

+ + +

Parameters

+ + + + + + + + + + + +
string$key

for the character set.

string$value

for the character set.

+ + +

Returns

+ $this + +
+
+ +
+ +
+
+ +
+

setOptions()

+ + 
setOptions(array  $options = array()) : $this
+

Set options for processing, defaults are available.

+ + +

Parameters

+ + + + + + +
array$options

to use as default settings.

+ + +

Returns

+ $this + +
+
+ +
+ +
+
+ +
+

createFromFile()

+ + 
createFromFile(string  $filename) : string
+

Create an Ascii image from an image file.

+ + +

Parameters

+ + + + + + +
string$filename

of the image to use.

+ + +

Returns

+ string + —

$ascii with the ASCII image.

+ +
+
+ +
+ +
+
+ +
+

luminanceAreaAverage()

+ + 
luminanceAreaAverage(string  $img, integer  $x1, integer  $y1, integer  $x2, integer  $y2) : integer
+

Get the luminance from a region of an image using average color value.

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
string$img

the image.

integer$x1

the area to get pixels from.

integer$y1

the area to get pixels from.

integer$x2

the area to get pixels from.

integer$y2

the area to get pixels from.

+ + +

Returns

+ integer + —

$luminance with a value between 0 and 100.

+ +
+
+ +
+ +
+
+ +
+

getLuminance()

+ + 
getLuminance(integer  $red, integer  $green, integer  $blue) : float
+

Calculate luminance value with different strategies.

+ + +

Parameters

+ + + + + + + + + + + + + + + + +
integer$red

The color red.

integer$green

The color green.

integer$blue

The color blue.

+ + +

Returns

+ float + —

$luminance with a value between 0 and 1.

+ +
+
+ +
+ +
+
+ +
+

luminance2character()

+ + 
luminance2character(  $luminance) : string
+

Translate the luminance value to a character.

+ + +

Parameters

+ + + + + + +
$luminance
+ + +

Returns

+ string + —

with the ascii character.

+ +
+
+ +
+ +
+
+ + + + +
+ + + diff --git a/docs/api/classes/CHttpGet.html b/docs/api/classes/CHttpGet.html index a456b80..ea8f9c1 100644 --- a/docs/api/classes/CHttpGet.html +++ b/docs/api/classes/CHttpGet.html @@ -106,12 +106,12 @@