Ignore:
Timestamp:
Nov 18, 2013, 6:36:35 PM (10 years ago)
Author:
mistic100
Message:

feature 2999: Documentation of include/functions_mail|metadata|picture

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/functions_picture.inc.php

    r19703 r25550  
    2222// +-----------------------------------------------------------------------+
    2323
     24/**
     25 * @package functions\picture
     26 */
    2427
    25 /*
    26  * get slideshow default params into array
     28
     29/**
     30 * Returns slideshow default params.
     31 * - period
     32 * - repeat
     33 * - play
    2734 *
    28  * @param void
    29  *
    30  * @return slideshow default values into array
     35 * @return array
    3136 */
    3237function get_default_slideshow_params()
    … …  
    4146}
    4247
    43 /*
    44  * check and correct slideshow params from array
     48/**
     49 * Checks and corrects slideshow params
    4550 *
    46  * @param array of params
    47  *
    48  * @return slideshow corrected values into array
     51 * @param array $params
     52 * @return array
    4953 */
    50 function correct_slideshow_params($params = array())
     54function correct_slideshow_params($params=array())
    5155{
    5256  global $conf;
    … …  
    6468}
    6569
    66 /*
    67  * Decode slideshow string params into array
     70/**
     71 * Decodes slideshow string params into array
    6872 *
    69  * @param string params like ""
    70  *
    71  * @return slideshow values into array
     73 * @param string $encode_params
     74 * @return array
    7275 */
    73 function decode_slideshow_params($encode_params = null)
     76function decode_slideshow_params($encode_params=null)
    7477{
    7578  global $conf;
    … …  
    106109}
    107110
    108 /*
    109  * Encode slideshow array params into array
     111/**
     112 * Encodes slideshow array params into a string
    110113 *
    111  * @param array params
    112  *
    113  * @return slideshow values into string
     114 * @param array $decode_params
     115 * @return string
    114116 */
    115 function encode_slideshow_params($decode_params = array())
     117function encode_slideshow_params($decode_params=array())
    116118{
    117119  global $conf;
    … …  
    128130  return $result;
    129131}
     132
    130133?>
Note: See TracChangeset for help on using the changeset viewer.