domci : Update CI PHP docs

git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@3457 bf3deb0d-5f1a-0410-827f-c0cc1f45334c
This commit is contained in:
2017-03-24 08:31:10 +00:00
parent 135ea40841
commit 9ffe45b072
2 changed files with 22 additions and 11 deletions

View File

@@ -80,7 +80,9 @@ class form
}
/** Add a field to the form. For the details of a field, see the description
* in fields method */
* in fields method
* @param object $field The field to add
*/
public function addfield ($field)
{
$this->fields[] = $field;
@@ -255,6 +257,9 @@ class form
/** Check if the parameters are correct with the defined fields
* Need the session !
* @param array $values The values to check
* @param array|null $fields The fields definition (or use the session
* stored one if the value is null)
* @return array containing the errors
*/
public function verify ($values, $fields=array ())
@@ -334,9 +339,9 @@ class form
* If the provided string is not corresponding to the format, don't change
* anything.
* Format used http://php.net/manual/en/datetime.createfromformat.php
* @param string $inputDate
* @param string $inputFormat
* @param string $outputFormat
* @param string $inputDate The date to modify
* @param string $inputFormat The input format of the date
* @param string $outputFormat The output format of the date
* @return string
*/
public function convertDate ($inputDate, $inputFormat, $outputFormat)

View File

@@ -542,7 +542,7 @@ class graphSerie
/** Set/get the numeric value of the serie
* If the parameter is not provided, return the actual state
* @param boolean|null The state of the numeric value
* @param boolean|null $numericalValue The state of the numeric value
*/
public function numericalValue ($numericalValue = null)
{
@@ -575,7 +575,7 @@ class graphSerie
/** Set/get the numeric key of the serie
* If the parameter is not provided, return the actual state
* @param boolean|null The state of the numeric key
* @param boolean|null $numericalKey The state of the numeric key
*/
public function numericalKey ($numericalKey = null)
{
@@ -1500,7 +1500,7 @@ class graphAxisGeneral
/** Set the axis color if the parameter is provided.
* Get the axis color if the parameter is not provided
* @param string|null $axiscolor The axis color
* @param string|null $axisColor The axis color
*/
public function axisColor ($axisColor = null)
{
@@ -1516,7 +1516,7 @@ class graphAxisGeneral
/** Set the grid color if the parameter is provided.
* Get the grid color if the parameter is not provided
* @param string|null $gridcolor The grid color
* @param string|null $gridColor The grid color
*/
public function gridColor ($gridColor = null)
{
@@ -1769,6 +1769,7 @@ class graphAxisX extends graphAxisHorizontal
/** Look for the height of the X axis based on the angle of the text when it
* will be drawn
* @param resource $gd The resource to modify
*/
public function getHeight ($gd)
{
@@ -1821,6 +1822,7 @@ class graphAxisX extends graphAxisHorizontal
}
/** Draw the axis
* @param resource $gd The resource to modify
*/
public function draw ($gd)
{
@@ -1938,6 +1940,7 @@ class graphAxisVertical extends graphAxisGeneral
protected $nbcharsLabel = 0;
/** Look for the width of the Y axis
* @param resource $gd The resource to modify
*/
public function getWidth ($gd)
{
@@ -2056,6 +2059,7 @@ class graphAxisVertical extends graphAxisGeneral
}
/** Draw the axis labels and lines
* @param resource $gd The resource to modify
*/
public function draw ($gd)
{
@@ -2101,8 +2105,8 @@ class graphAxisY1 extends graphAxisVertical
{
/** Draw one value on the axis
* @param resource $gd The resource to modify
* @param integer|float $value The value to draw
* @param integer $width The width of the labels on the axis
* @param integer|float $val The value to draw
*/
protected function drawOne ($gd, $width, $val)
{
@@ -2179,8 +2183,8 @@ class graphAxisY2 extends graphAxisVertical
{
/** Draw one value on the axis
* @param resource $gd The resource to modify
* @param integer|float $value The value to draw
* @param integer $width The width of the labels on the axis
* @param integer|float $val The value to draw
*/
protected function drawOne ($gd, $width, $val)
{
@@ -2574,7 +2578,9 @@ class graphStyleLine extends graphStyleLinePoints
class graphPalette
/* {{{ */
{
/** Get the complete palette */
/** Get the complete palette
* @param string $name The palette name to get
*/
public static function getPalette ($name)
{
$palette = array (