php docblock

docblock.txt

/**
 * Quotes arg2 into arg1
 *
 * This method quotes the integer carried by arg2 into the string
 * carried by arg1. This method uses the PHP function sprintf
 * and returns the resulting string. FALSE if the integer was 0.
 *
 * @param string $arg1 the string to quote
 * @param int    $arg2 an integer containing some value to quote.
 *                     Indent to the description's starting point
 *                     if it exceeds single line.
 *
 * @return string the string returning some value. FALSE if the
 *                operation was unsuccessful.
 *
 * @throws Exception the std exception containing message that the
 *                   input arguments are not valid. Thrown if the
 *                   arg1 is empty or null or not a string.
 *
 * @access public
 * @static
 * @since Method available since Release
 * @deprecated Method deprecated in Release
 */