Skip to content
Browse files

Improve class declarations and further improve code style.

  • Loading branch information...
1 parent 34f2656 commit 8e84ff0aedb90a220e39e88a9354f62dfaf194e7 @realityking realityking committed Aug 12, 2012
View
2 administrator/components/com_admin/models/sysinfo.php
@@ -10,7 +10,7 @@
defined('_JEXEC') or die;
/**
- * Model for the system information
+ * Model for the display of system information.
*
* @package Joomla.Administrator
* @subpackage com_admin
View
1 administrator/components/com_admin/script.php
@@ -14,6 +14,7 @@
*
* @package Joomla.Administrator
* @subpackage com_admin
+ * @since 1.6.4
*/
class joomlaInstallerScript
{
View
3 administrator/components/com_admin/views/profile/view.html.php
@@ -10,10 +10,11 @@
defined('_JEXEC') or die;
/**
- * View for the user profile
+ * View class to allow users edit their own profile.
*
* @package Joomla.Administrator
* @subpackage com_admin
+ * @since 1.6
*/
class AdminViewProfile extends JViewLegacy
{
View
1 includes/application.php
@@ -15,6 +15,7 @@
*
* @package Joomla.Site
* @subpackage Application
+ * @since 1.5
*/
final class JSite extends JApplication
{
View
21 installation/controller.php
@@ -29,21 +29,21 @@ class InstallationController extends JControllerLegacy
public function display($cachable = false, $urlparams = false)
{
// Get the current URI to redirect to.
- $uri = JURI::getInstance();
- $redirect = base64_encode($uri);
+ $uri = JURI::getInstance();
+ $redirect = base64_encode($uri);
// Get the document object.
- $document = JFactory::getDocument();
+ $document = JFactory::getDocument();
// Set the default view name and format from the Request.
if (file_exists(JPATH_CONFIGURATION . '/configuration.php') && (filesize(JPATH_CONFIGURATION . '/configuration.php') > 10)
&& file_exists(JPATH_INSTALLATION . '/index.php'))
{
- $default_view = 'remove';
+ $default_view = 'remove';
}
else
{
- $default_view = 'language';
+ $default_view = 'language';
}
$vName = $this->input->getWord('view', $default_view);
@@ -55,15 +55,10 @@ public function display($cachable = false, $urlparams = false)
$this->input->set('view', $default_view);
}
- if ($view = $this->getView($vName, $vFormat))
+ $view = $this->getView($vName, $vFormat);
+ if ($view)
{
-
- switch ($vName)
- {
- default:
- $model = $this->getModel('Setup', 'InstallationModel', array('dbo' => null));
- break;
- }
+ $model = $this->getModel('Setup', 'InstallationModel', array('dbo' => null));
// Push the model into the view (as default).
$view->setModel($model, true);
View
5 installation/includes/application.php
@@ -14,6 +14,7 @@
* Provide many supporting API functions
*
* @package Joomla.Installation
+ * @since 1.5
*/
class JInstallation extends JApplication
{
@@ -42,8 +43,8 @@ public function __construct(array $config = array())
public function render()
{
$document = JFactory::getDocument();
- $config = JFactory::getConfig();
- $user = JFactory::getUser();
+ $config = JFactory::getConfig();
+ $user = JFactory::getUser();
switch ($document->getType())
{
View
1 modules/mod_banners/helper.php
@@ -12,6 +12,7 @@
/**
* @package Joomla.Site
* @subpackage mod_banners
+ * @since 1.5
*/
class modBannersHelper
{
View
1 modules/mod_breadcrumbs/helper.php
@@ -12,6 +12,7 @@
/**
* @package Joomla.Site
* @subpackage mod_breadcrumbs
+ * @since 1.5
*/
class modBreadCrumbsHelper
{
View
1 modules/mod_feed/helper.php
@@ -12,6 +12,7 @@
/**
* @package Joomla.Site
* @subpackage mod_feed
+ * @since 1.5
*/
class modFeedHelper
{
View
1 modules/mod_login/helper.php
@@ -12,6 +12,7 @@
/**
* @package Joomla.Site
* @subpackage mod_login
+ * @since 1.5
*/
class modLoginHelper
{
View
1 modules/mod_random_image/helper.php
@@ -12,6 +12,7 @@
/**
* @package Joomla.Site
* @subpackage mod_random_image
+ * @since 1.5
*/
class modRandomImageHelper
{
View
1 modules/mod_related_items/helper.php
@@ -14,6 +14,7 @@
/**
* @package Joomla.Site
* @subpackage mod_related_items
+ * @since 1.5
*/
abstract class modRelatedItemsHelper
{
View
1 modules/mod_syndicate/helper.php
@@ -12,6 +12,7 @@
/**
* @package Joomla.Site
* @subpackage mod_syndicate
+ * @since 1.5
*/
class modSyndicateHelper
{
View
1 modules/mod_whosonline/helper.php
@@ -12,6 +12,7 @@
/**
* @package Joomla.Site
* @subpackage mod_whosonline
+ * @since 1.5
*/
class modWhosonlineHelper
{
View
1 modules/mod_wrapper/helper.php
@@ -12,6 +12,7 @@
/**
* @package Joomla.Site
* @subpackage mod_wrapper
+ * @since 1.5
*/
class modWrapperHelper
{
View
1 plugins/content/emailcloak/emailcloak.php
@@ -14,6 +14,7 @@
*
* @package Joomla.Plugin
* @subpackage Content.emailcloak
+ * @since 1.5
*/
class plgContentEmailcloak extends JPlugin
{
View
1 plugins/content/loadmodule/loadmodule.php
@@ -15,6 +15,7 @@
*
* @package Joomla.Plugin
* @subpackage Content.loadmodule
+ * @since 1.5
*/
class plgContentLoadmodule extends JPlugin
{
View
1 plugins/content/pagenavigation/pagenavigation.php
@@ -14,6 +14,7 @@
*
* @package Joomla.Plugin
* @subpackage Content.pagenavigation
+ * @since 1.5
*/
class plgContentPagenavigation extends JPlugin
{
View
1 plugins/content/vote/vote.php
@@ -14,6 +14,7 @@
*
* @package Joomla.Plugin
* @subpackage Content.vote
+ * @since 1.5
*/
class plgContentVote extends JPlugin
{
View
3 plugins/system/languagecode/languagecode.php
@@ -14,11 +14,14 @@
*
* @package Joomla.Plugin
* @subpackage Content.languagecode
+ * @since 2.5
*/
class plgSystemLanguagecode extends JPlugin
{
/**
* Plugin that change the language code used in the <html /> tag
+ *
+ * @since 2.5
*/
public function onAfterRender()
{
View
1 plugins/system/log/log.php
@@ -14,6 +14,7 @@
*
* @package Joomla.Plugin
* @subpackage System.log
+ * @since 1.5
*/
class plgSystemLog extends JPlugin
{
View
7 plugins/system/logout/logout.php
@@ -14,6 +14,7 @@
*
* @package Joomla.Plugin
* @subpackage System.logout
+ * @since 1-6
*/
class plgSystemLogout extends JPlugin
{
@@ -24,7 +25,7 @@ class plgSystemLogout extends JPlugin
* @param object The object to observe -- event dispatcher.
* @param object The configuration object for the plugin.
* @return void
- * @since 1.5
+ * @since 1.6
*/
function __construct(&$subject, $config)
{
@@ -51,8 +52,8 @@ function __construct(&$subject, $config)
* @param array $user Holds the user data.
* @param array $options Array holding options (client, ...).
*
- * @return object True on success
- * @since 1.5
+ * @return boolean Always returns true
+ * @since 1.6
*/
public function onUserLogout($user, $options = array())
{
View
4 plugins/system/p3p/p3p.php
@@ -14,9 +14,13 @@
*
* @package Joomla.Plugin
* @subpackage System.p3p
+ * @since 1.6
*/
class plgSystemP3p extends JPlugin
{
+ /*
+ * @since 1.6
+ */
function onAfterInitialise()
{
// Get the header
View
3 plugins/system/redirect/redirect.php
@@ -14,6 +14,7 @@
*
* @package Joomla.Plugin
* @subpackage System.redirect
+ * @since 1.6
*/
class plgSystemRedirect extends JPlugin
{
@@ -24,7 +25,7 @@ class plgSystemRedirect extends JPlugin
* @param object The object to observe -- event dispatcher.
* @param object The configuration object for the plugin.
* @return void
- * @since 1.0
+ * @since 1.6
*/
function __construct(&$subject, $config)
{
View
1 plugins/system/remember/remember.php
@@ -14,6 +14,7 @@
*
* @package Joomla.Plugin
* @subpackage System.remember
+ * @since 1.5
*/
class plgSystemRemember extends JPlugin
{
View
1 plugins/system/sef/sef.php
@@ -13,6 +13,7 @@
*
* @package Joomla.Plugin
* @subpackage System.sef
+ * @since 1.5
*/
class plgSystemSef extends JPlugin
{

0 comments on commit 8e84ff0

Please sign in to comment.
Something went wrong with that request. Please try again.