Skip to content

Commit 20cac9a

Browse files
robocoderrobocoder
committed
phpdoc cleanup:
 * add @category (Piwik => 'core', Piwik_Plugins => 'plugins') * in core, use @Package and @subpackage more consistently to group files/classes; exception is DataFiles/*, PluginsFunctions/*, and SmartyPlugins/* * in plugins, @Package is the plugin name * removed '@param none' -- not a phpdoc convention * '@throws' and '@return void' are also not phpdoc conventions, but are widely used elsewhere, e.g., Smarty & Zend git-svn-id: http://dev.piwik.org/svn/trunk@1420 59fd770c-687e-43c8-a1e3-f5a4ff64c105
1 parent 6eb358f commit 20cac9a

230 files changed

Lines changed: 1086 additions & 608 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎core/API/DataTableGenericFilter.php‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,14 @@
66
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
77
* @version $Id$
88
*
9-
* @package Piwik_API
9+
* @category Piwik
10+
* @package Piwik
1011
*/
1112

13+
/**
14+
* @package Piwik
15+
* @subpackage Piwik_API
16+
*/
1217
class Piwik_API_DataTableGenericFilter
1318
{
1419
function __construct( $datatable, $request )
@@ -73,7 +78,6 @@ public static function getGenericFiltersInformation()
7378
* Disable this feature by setting the parameter disable_generic_filters to 1 in the API call request.
7479
*
7580
* @param Piwik_DataTable
76-
* @return void
7781
*/
7882
protected function applyGenericFilters($datatable)
7983
{

‎core/API/DocumentationGenerator.php‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,14 @@
66
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
77
* @version $Id$
88
*
9-
* @package Piwik_API
9+
* @category Piwik
10+
* @package Piwik
1011
*/
1112

13+
/**
14+
* @package Piwik
15+
* @subpackage Piwik_API
16+
*/
1217
class Piwik_API_DocumentationGenerator
1318
{
1419
protected $countPluginsLoaded = 0;
@@ -193,6 +198,5 @@ protected function getStrListParameters($class, $name)
193198
}
194199
$sParameters = implode(", ", $asParameters);
195200
return "($sParameters)";
196-
}
197-
201+
}
198202
}

‎core/API/Proxy.php‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
77
* @version $Id$
88
*
9-
* @package Piwik_API
9+
* @category Piwik
10+
* @package Piwik
1011
*/
1112

1213
/**
@@ -17,7 +18,8 @@
1718
*
1819
* It will also log the performance of API calls (time spent, parameter values, etc.) if logger available
1920
*
20-
* @package Piwik_API
21+
* @package Piwik
22+
* @subpackage Piwik_API
2123
*/
2224
class Piwik_API_Proxy
2325
{

‎core/API/Request.php‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
77
* @version $Id$
88
*
9-
*
10-
* @package Piwik_API
9+
* @category Piwik
10+
* @package Piwik
1111
*/
1212

1313
/**
@@ -33,7 +33,8 @@
3333
* echo $result;
3434
*
3535
* @see http://dev.piwik.org/trac/wiki/API
36-
* @package Piwik_API
36+
* @package Piwik
37+
* @subpackage Piwik_API
3738
*/
3839
class Piwik_API_Request
3940
{

‎core/API/ResponseBuilder.php‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,14 @@
66
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
77
* @version $Id$
88
*
9-
* @package Piwik_API
9+
* @category Piwik
10+
* @package Piwik
1011
*/
1112

13+
/**
14+
* @package Piwik
15+
* @subpackage Piwik_API
16+
*/
1217
class Piwik_API_ResponseBuilder
1318
{
1419
private $request = null;

‎core/Access.php‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
77
* @version $Id$
88
*
9+
* @category Piwik
910
* @package Piwik
10-
*
1111
*/
1212

1313
/**
@@ -33,6 +33,7 @@
3333
* and he only can change the main configuration settings.
3434
*
3535
* @package Piwik
36+
* @subpackage Piwik_Access
3637
*/
3738
class Piwik_Access
3839
{
@@ -155,7 +156,12 @@ public function reloadAccess(Piwik_Auth $auth = null)
155156
}
156157
return true;
157158
}
158-
159+
160+
/**
161+
* Reload super user access
162+
*
163+
* @return bool
164+
*/
159165
protected function reloadAccessSuperUser()
160166
{
161167
$this->isSuperUser = true;
@@ -166,8 +172,6 @@ protected function reloadAccessSuperUser()
166172
/**
167173
* We bypass the normal auth method and give the current user Super User rights.
168174
* This should be very carefully used.
169-
*
170-
* @return void
171175
*/
172176
public function setSuperUser()
173177
{
@@ -186,6 +190,7 @@ public function isSuperUser()
186190

187191
/**
188192
* Returns the current user login
193+
*
189194
* @return string|null
190195
*/
191196
public function getLogin()
@@ -195,6 +200,7 @@ public function getLogin()
195200

196201
/**
197202
* Returns the token_auth used to authenticate this user in the API
203+
*
198204
* @return string|null
199205
*/
200206
public function getTokenAuth()
@@ -261,6 +267,7 @@ public function checkUserIsSuperUser()
261267

262268
/**
263269
* If the user doesn't have an ADMIN access for at least one website, throws an exception
270+
*
264271
* @throws Exception
265272
*/
266273
public function checkUserHasSomeAdminAccess()
@@ -274,6 +281,7 @@ public function checkUserHasSomeAdminAccess()
274281

275282
/**
276283
* If the user doesn't have any view permission, throw exception
284+
*
277285
* @throws Exception
278286
*/
279287
public function checkUserHasSomeViewAccess()
@@ -347,6 +355,7 @@ public function checkUserHasViewAccess( $idSites )
347355
* Exception thrown when a user doesn't have sufficient access.
348356
*
349357
* @package Piwik
358+
* @subpackage Piwik_Access
350359
*/
351360
class Piwik_Access_NoAccessException extends Exception
352361
{}

‎core/Archive.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
77
* @version $Id$
88
*
9+
* @category Piwik
910
* @package Piwik
1011
*/
1112

‎core/Archive/Array.php‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
77
* @version $Id$
88
*
9-
*
10-
* @package Piwik_Archive
9+
* @category Piwik
10+
* @package Piwik
1111
*/
1212

1313
/**
1414
* Piwik_Archive_Array is used to store multiple archives,
1515
* for example one archive for a given day for each Piwik website
1616
*
17+
* @package Piwik
18+
* @subpackage Piwik_Archive
1719
*/
1820
abstract class Piwik_Archive_Array extends Piwik_Archive
1921
{

‎core/Archive/Array/IndexedByDate.php‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,14 @@
66
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
77
* @version $Id$
88
*
9-
* @package Piwik_Archive
9+
* @category Piwik
10+
* @package Piwik
1011
*/
1112

13+
/**
14+
* @package Piwik
15+
* @subpackage Piwik_Archive
16+
*/
1217
class Piwik_Archive_Array_IndexedByDate extends Piwik_Archive_Array
1318
{
1419
/**

‎core/Archive/Array/IndexedBySite.php‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,14 @@
66
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
77
* @version $Id$
88
*
9-
* @package Piwik_Archive
9+
* @category Piwik
10+
* @package Piwik
1011
*/
1112

13+
/**
14+
* @package Piwik
15+
* @subpackage Piwik_Archive
16+
*/
1217
class Piwik_Archive_Array_IndexedBySite extends Piwik_Archive_Array
1318
{
1419
/**

0 commit comments

Comments
 (0)