Skip to content

Commit

Permalink
Doc block work, continued
Browse files Browse the repository at this point in the history
  • Loading branch information
elinw committed May 18, 2011
1 parent 7f3c042 commit 0e5efc6
Show file tree
Hide file tree
Showing 42 changed files with 352 additions and 294 deletions.
6 changes: 3 additions & 3 deletions libraries/joomla/application/component/controller.php
Original file line number Diff line number Diff line change
Expand Up @@ -893,10 +893,10 @@ public function registerTask($task, $method)
/**
* Unregister (unmap) a task in the class.
*
* @param string $task The task.
* @param string $task The task.
*
* @return JController This object to support chaining.
* @since 11.1
* @return JController This object to support chaining.
* @since 11.1
*/
public function unregisterTask($task)
{
Expand Down
26 changes: 13 additions & 13 deletions libraries/joomla/application/component/model.php
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ abstract class JModel extends JObject

/**
* @var string The event to trigger when cleaning cache.
* @since 11.1
* @since 11.1
*/
protected $event_clean_cache = null;

Expand Down Expand Up @@ -127,11 +127,11 @@ public static function addTablePath($path)
/**
* Create the filename for a resource
*
* @param string $type The resource type to create the filename for.
* @param array $parts An associative array of filename information.
* @param string $type The resource type to create the filename for.
* @param array $parts An associative array of filename information.
*
* @return string The filename
* @since 11.1
* @return string The filename
* @since 11.1
*/
protected static function _createFileName($type, $parts = array())
{
Expand Down Expand Up @@ -295,12 +295,12 @@ protected function _getListCount($query)
/**
* Method to load and return a model object.
*
* @param string $name The name of the view
* @param string $prefix The class prefix. Optional.
* @param array $config Configuration settings to pass to JTable::getInsance
* @param string $name The name of the view
* @param string $prefix The class prefix. Optional.
* @param array $config Configuration settings to pass to JTable::getInsance
*
* @return mixed Model object or boolean false if failed
* @since 11.1
* @return mixed Model object or boolean false if failed
* @since 11.1
* @see JTable::getInstance
*/
protected function _createTable($name, $prefix = 'Table', $config = array())
Expand Down Expand Up @@ -444,12 +444,12 @@ public function setState($property, $value = null)
/**
* Clean the cache
*
* @param string $group The cache group
* @param string $client_id The ID of the client
* @param string $group The cache group
* @param string $client_id The ID of the client
*
* @return void
*
* @since 1.6
* @since 1.6
*/
protected function cleanCache($group = null, $client_id = 0)
{
Expand Down
2 changes: 1 addition & 1 deletion libraries/joomla/application/component/modelform.php
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ protected function preprocessForm(JForm $form, $data, $group = 'content')
* @param object $form The form to validate against.
* @param array $data The data to validate.
* @return mixed Array of filtered data if valid, false otherwise.
* @since 1.1
* @since 1.1
*/
function validate($form, $data)
{
Expand Down
6 changes: 3 additions & 3 deletions libraries/joomla/application/component/view.php
Original file line number Diff line number Diff line change
Expand Up @@ -679,10 +679,10 @@ protected function _addPath($type, $path)
/**
* Create the filename for a resource
*
* @param string The resource type to create the filename for
* @param array An associative array of filename information
* @param string The resource type to create the filename for
* @param array An associative array of filename information
*
* @return string The filename
* @return string The filename
* @since 11.1
*/
protected function _createFileName($type, $parts = array())
Expand Down
2 changes: 1 addition & 1 deletion libraries/joomla/application/input.php
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ public function get($name, $default = null, $filter = 'cmd')
* Gets an array of values from the request.
*
* @param array $vars Associative array of keys and filter types to apply.
* @param mixed $datasource Array to retrieve data from, or null
* @param mixed $datasource Array to retrieve data from, or null
*
* @return mixed The filtered input data.
*
Expand Down
2 changes: 1 addition & 1 deletion libraries/joomla/cache/controller/page.php
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ protected function _noChange()
*
* @return void
*
* @since 11.1
* @since 11.1
*/
protected function _setEtag($etag)
{
Expand Down
2 changes: 1 addition & 1 deletion libraries/joomla/cache/storage/memcache.php
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ public function unlock($id,$group=null)
/**
* Lock cache index
*
* @since 11.1
* @since 11.1
* @return boolean True on success, false otherwise.
*/
protected function lockindex()
Expand Down
8 changes: 4 additions & 4 deletions libraries/joomla/client/ftp.php
Original file line number Diff line number Diff line change
Expand Up @@ -833,8 +833,8 @@ function get($local, $remote) {
/**
* Method to store a file to the FTP server
*
* @param string $local Path to local file to store on the FTP server
* @param string $remote FTP path to file to create
* @param string $local Path to local file to store on the FTP server
* @param string $remote FTP path to file to create
*
* @return boolean True if successful
*/
Expand Down Expand Up @@ -1076,7 +1076,7 @@ function listNames($path = null) {
/**
* Method to list the contents of a directory on the FTP server
*
* @param string $path Path to the local file to be stored on the FTP server
* @param string $path Path to the local file to be stored on the FTP server
* @param string $type Return type [raw|all|folders|files]
* @param boolean $search Recursively search subdirectories
*
Expand Down Expand Up @@ -1274,7 +1274,7 @@ function listDetails($path = null, $type = 'all') {
/**
* Send command to the FTP server and validate an expected response code
*
* @param string $cmd Command to send to the FTP server
* @param string $cmd Command to send to the FTP server
* @param mixed $expectedResponse Integer response code or array of
* integer response codes
* @return boolean True if command executed successfully
Expand Down
8 changes: 4 additions & 4 deletions libraries/joomla/database/database/mysqliimporter.php
Original file line number Diff line number Diff line change
Expand Up @@ -393,8 +393,8 @@ protected function getDropColumnSQL($table, $name)
/**
* Get the SQL syntax to drop a key.
*
* @param string $table The table name.
* @param string $field The name of the key to drop.
* @param string $table The table name.
* @param string $field The name of the key to drop.
*
* @return string
* @since 11.1
Expand All @@ -410,7 +410,7 @@ protected function getDropKeySQL($table, $name)
/**
* Get the SQL syntax to drop a key.
*
* @param string $table The table name.
* @param string $table The table name.
*
* @return string
* @since 11.1
Expand Down Expand Up @@ -501,7 +501,7 @@ protected function getKeySQL($columns)
/**
* Get the real name of the table, converting the prefix wildcard string if present.
*
* @param string $table The name of the table.
* @param string $table The name of the table.
*
* @return string The real name of the table.
* @since 11.1
Expand Down
8 changes: 4 additions & 4 deletions libraries/joomla/database/database/mysqlimporter.php
Original file line number Diff line number Diff line change
Expand Up @@ -421,8 +421,8 @@ protected function getDropColumnSQL($table, $name)
/**
* Get the SQL syntax to drop a key.
*
* @param string $table The table name.
* @param string $field The name of the key to drop.
* @param string $table The table name.
* @param string $field The name of the key to drop.
*
* @return string
* @since 11.1
Expand All @@ -438,7 +438,7 @@ protected function getDropKeySQL($table, $name)
/**
* Get the SQL syntax to drop a key.
*
* @param string $table The table name.
* @param string $table The table name.
*
* @return string
* @since 11.1
Expand Down Expand Up @@ -557,7 +557,7 @@ protected function getKeys($table)
/**
* Get the real name of the table, converting the prefix wildcard string if present.
*
* @param string $table The name of the table.
* @param string $table The name of the table.
*
* @return string The real name of the table.
* @since 11.1
Expand Down
6 changes: 3 additions & 3 deletions libraries/joomla/database/databasequery.php
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ class JDatabaseQueryElement
/**
* Constructor.
*
* @param string $name The name of the element.
* @param mixed $elements String or array.
* @param string $glue The glue for elements.
* @param string $name The name of the element.
* @param mixed $elements String or array.
* @param string $glue The glue for elements.
*
* @return JDatabaseQueryElement
*
Expand Down
Loading

0 comments on commit 0e5efc6

Please sign in to comment.