Phpdoc

🗃️ Library for recognizing PHPDoc Tags in PHP DocBlock comments

Generate Convert Improve

Install / Use

/learn @php-type-language/Phpdoc

About this skill

Quality Score

0/100

README

Reference implementation for TypeLang PHPDoc Parser.

Read documentation pages for more information.

Installation

TypeLang PHPDoc Parser is available as Composer repository and can be installed using the following command in a root of your project:

composer require type-lang/phpdoc

Supported Tags

[x] @abstract - Declare any Element as abstract
[x] @api - Highlight Element as being part of the public API
[ ] @author - TODO
[x] @category - Used to organize groups of packages together
[x] @copyright - Used to document the copyright information of any Element.
[ ] @deprecated - TODO
[ ] @example - TODO
[x] @extends - Allows to extend templated classes and interfaces
[ ] @filesource - TODO
[x] @final - Declare any Element as final
[ ] @global - TODO
[x] @ignore - Used to tell documentation systems that Element are not to be processed.
[x] @implements - Allows to extend templated interfaces
[ ] @inheritdoc - TODO
[x] @inherits - An alias of @extends tag
[ ] @internal - TODO
[x] @license - Used to indicate which license is applicable
[x] @link - Indicates a custom relation between the associated Element and a website, which is identified by an absolute URI
[x] @method - Allows a class to know which "magic" methods are callable
[ ] @mixin - TODO
[x] @no-named-arguments - Indicates that argument names may be changed in the future.
[x] @package - Used to categorize Element(s) into logical subdivisions
[x] @override - Mention to see if the method is actually overriding a definition
[x] @param - Used to document a single argument of a function or method
[ ] @param-closure-this - TODO
[ ] @param-immediately-invoked-callable - TODO
[ ] @param-later-invoked-callable - TODO
[ ] @param-out - TODO
[x] @property - Used to declare which "magic" properties are supported
[x] @property-read - Used to declare which "magic" properties are supported for reading
[x] @property-write - Used to declare which "magic" properties are supported for writing
[ ] @pure-unless-callable-is-impure - TODO
[ ] @readonly - TODO
[ ] @require-extends - TODO
[ ] @require-implements - TODO
[x] @return - Used to document the return value of functions or methods
[x] @returns - An alias of @return tag
[ ] @seal-methods - TODO
[ ] @seal-properties - TODO
[x] @see - Indicates a reference from the associated Symbol(s) to a website or other Symbol(s)
[ ] @since - TODO
[ ] @source - TODO
[x] @subpackage - Used to categorize Element(s) into logical subdivisions
[ ] @suppress - TODO
[x] @template - Allows classes (and class-like entries), functions and methods to declare a generic type parameter
[x] @template-contravariant - Allows classes (and class-like entries), functions and methods to declare a generic contravariant type parameter
[x] @template-covariant - Allows classes (and class-like entries), functions and methods to declare a generic covariant type parameter
[x] @template-extends - An alias of @extends tag
[x] @template-implements - An alias of @implements tag
[x] @template-use - Allows to extend templated traits
[x] @throw - An alias of @throws tag
[x] @throws - Used to indicate whether Element throw a specific type of \Throwable (exception or error)
[ ] @todo - TODO
[ ] @unused-param - TODO
[x] @use - An alias of @template-use tag
[ ] @used-by - TODO
[ ] @uses - TODO
[x] @var - Document the Type of the following Element
[ ] @version - TODO

Psalm Tags

[ ] @psalm-allow-private-mutation - TODO
[x] @psalm-api - Vendor-specific @api alias
[ ] @psalm-assert - TODO
[ ] @psalm-assert-if-false - TODO
[ ] @psalm-assert-if-true - TODO
[ ] @psalm-assert-untainted - TODO
[ ] @psalm-check-type - TODO
[ ] @psalm-check-type-exact - TODO
[ ] @psalm-consistent-constructor - TODO
[ ] @psalm-consistent-templates - TODO
[ ] @psalm-external-mutation-free - TODO
[x] @psalm-extends - Vendor-specific @extends alias
[ ] @psalm-flow - TODO
[ ] @psalm-if-this-is - TODO
[ ] @psalm-ignore-falsable-return - TODO
[ ] @psalm-ignore-nullable-return - TODO
[ ] @psalm-ignore-var - TODO
[ ] @psalm-ignore-variable-method - TODO
[ ] @psalm-ignore-variable-property - TODO
[ ] @psalm-immutable - TODO
[x] @psalm-implements - Vendor-specific @implements alias
[ ] @psalm-import-type - TODO
[ ] @psalm-inheritors - TODO
[ ] @psalm-internal - TODO
[x] @psalm-method - Vendor-specific @method alias
[ ] @psalm-mutation-free - TODO
[ ] @psalm-no-seal-methods - TODO

Related Skills

node-connect

339.3k

Diagnose OpenClaw node connection and pairing failures for Android, iOS, and macOS companion apps

frontend-design

83.9k

Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, or applications. Generates creative, polished code that avoids generic AI aesthetics.

openai-whisper-api

339.3k

Transcribe audio via OpenAI Audio Transcriptions API (Whisper).

commit-push-pr

83.9k

Commit, push, and open a PR