Skip to content

Commit

Permalink
Fix phpdoc. (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
terabytesoftw authored Oct 23, 2023
1 parent d1518fd commit eb0e384
Show file tree
Hide file tree
Showing 48 changed files with 554 additions and 15 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<a href="https://github.com/yii2-extensions/debug/actions/workflows/static.yml" target="_blank">
<img src="https://github.com/yii2-extensions/debug/actions/workflows/static.yml/badge.svg" alt="PHPStan">
</a>
<a href="https://github.com/yii2-extensions/app-basic/actions/workflows/static.yml" target="_blank">
<a href="https://github.com/yii2-extensions/debug/actions/workflows/static.yml" target="_blank">
<img src="https://img.shields.io/badge/PHPStan%20level-1-blue" alt="PHPStan level">
</a>
<a href="https://github.styleci.io/repos/699842423?branch=main" target="_blank">
Expand Down
13 changes: 12 additions & 1 deletion src/DbAsset.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,23 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug;

use yii\web\AssetBundle;

/**
* DB asset bundle
* DB asset bundle.
*
* @author Simon Karlen (simi.albi@outlook.com)
*
* @since 2.1.0
*/
class DbAsset extends AssetBundle
{
Expand Down
13 changes: 12 additions & 1 deletion src/DebugAsset.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,23 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug;

use yii\web\AssetBundle;

/**
* Debugger asset bundle
* Debugger asset bundle.
*
* @author Qiang Xue <qiang.xue@gmail.com>
*
* @since 2.0
*/
class DebugAsset extends AssetBundle
{
Expand Down
13 changes: 11 additions & 2 deletions src/FlattenException.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug;

use __PHP_Incomplete_Class;
Expand All @@ -24,9 +31,11 @@
* FlattenException wraps a PHP Exception to be able to serialize it.
* Implements the Throwable interface.
* Basically, this class removes all objects from the trace.
* Ported from Symfony components
* Ported from Symfony components @link https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Debug/Exception/FlattenException.php
*
* @author Dmitry Bashkarev <dmitry@bashkarev.com>
*
* @link https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Debug/Exception/FlattenException.php
* @since 2.0.10
*/
class FlattenException
{
Expand Down
11 changes: 11 additions & 0 deletions src/LogTarget.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug;

use Yii;
Expand All @@ -21,6 +28,10 @@

/**
* The debug LogTarget is used to store logs for later use in the debugger tool.
*
* @author Qiang Xue <qiang.xue@gmail.com>
*
* @since 2.0
*/
class LogTarget extends Target
{
Expand Down
11 changes: 11 additions & 0 deletions src/Module.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug;

use JsonException;
Expand Down Expand Up @@ -47,6 +54,10 @@

/**
* The Yii Debug Module provides the debug toolbar and debugger.
*
* @author Qiang Xue <qiang.xue@gmail.com>
*
* @since 2.0
*/
class Module extends \yii\base\Module implements BootstrapInterface
{
Expand Down
21 changes: 18 additions & 3 deletions src/Panel.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug;

use Closure;
Expand All @@ -13,9 +20,17 @@
use yii\helpers\VarDumper;

/**
* Panel is a base class for debugger panel classes.
* It defines how data should be collected, what should be displayed
* in the debug toolbar and on the debugger details view.
* Panel is a base class for debugger panel classes. It defines how data should be collected,
* what should be displayed at debug toolbar and on debugger details view.
*
* @property string $detail Content that is displayed in debugger detail view.
* @property string $name Name of the panel.
* @property string $summary Content that is displayed at debug toolbar.
* @property string $url URL pointing to panel detail view.
*
* @author Qiang Xue <qiang.xue@gmail.com>
*
* @since 2.0
*/
class Panel extends Component
{
Expand Down
13 changes: 12 additions & 1 deletion src/TimelineAsset.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,23 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug;

use yii\web\AssetBundle;

/**
* Timeline asset bundle.
* Timeline asset bundle
*
* @author Dmitriy Bashkarev <dmitriy@bashkarev.com>
*
* @since 2.0.7
*/
class TimelineAsset extends AssetBundle
{
Expand Down
13 changes: 12 additions & 1 deletion src/UserswitchAsset.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,23 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug;

use yii\web\AssetBundle;

/**
* User switch asset bundle.
* User switch asset bundle
*
* @author Semen Dubina <yii2debug@sam002.net>
*
* @since 2.0.10
*/
class UserswitchAsset extends AssetBundle
{
Expand Down
11 changes: 11 additions & 0 deletions src/actions/db/ExplainAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug\actions\db;

use yii\base\Action;
Expand All @@ -18,6 +25,10 @@

/**
* ExplainAction provides EXPLAIN information for SQL queries
*
* @author Laszlo <github@lvlconsultancy.nl>
*
* @since 2.0.6
*/
class ExplainAction extends Action
{
Expand Down
11 changes: 11 additions & 0 deletions src/components/search/Filter.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,24 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug\components\search;

use yii\base\Component;
use yii\debug\components\search\matchers\MatcherInterface;

/**
* Provides array filtering capabilities.
*
* @author Mark Jebri <mark.github@yandex.ru>
*
* @since 2.0
*/
class Filter extends Component
{
Expand Down
11 changes: 11 additions & 0 deletions src/components/search/matchers/Base.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,23 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug\components\search\matchers;

use yii\base\Component;

/**
* Base class for matchers that are used in a filter.
*
* @author Mark Jebri <mark.github@yandex.ru>
*
* @since 2.0
*/
abstract class Base extends Component implements MatcherInterface
{
Expand Down
11 changes: 11 additions & 0 deletions src/components/search/matchers/GreaterThan.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,21 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug\components\search\matchers;

/**
* Checks if the given value is greater than the base one.
*
* @author Mark Jebri <mark.github@yandex.ru>
*
* @since 2.0
*/
class GreaterThan extends Base
{
Expand Down
11 changes: 11 additions & 0 deletions src/components/search/matchers/GreaterThanOrEqual.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,21 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug\components\search\matchers;

/**
* Checks if the given value is greater than or equal the base one.
*
* @author Dmitriy Bashkarev <dmitriy@bashkarev.com>
*
* @since 2.0.7
*/
class GreaterThanOrEqual extends Base
{
Expand Down
11 changes: 11 additions & 0 deletions src/components/search/matchers/LowerThan.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,21 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug\components\search\matchers;

/**
* Checks if the given value is lower than the base one.
*
* @author Mark Jebri <mark.github@yandex.ru>
*
* @since 2.0
*/
class LowerThan extends Base
{
Expand Down
11 changes: 11 additions & 0 deletions src/components/search/matchers/MatcherInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,21 @@

declare(strict_types=1);

/**
* @link https://www.yiiframework.com/
*
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/

namespace yii\debug\components\search\matchers;

/**
* MatcherInterface should be implemented by all matchers that are used in a filter.
*
* @author Mark Jebri <mark.github@yandex.ru>
*
* @since 2.0
*/
interface MatcherInterface
{
Expand Down
Loading

0 comments on commit eb0e384

Please sign in to comment.