PHPackages                             fasano/typedocs - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. fasano/typedocs

ActiveLibrary[Utility & Helpers](/categories/utility)

fasano/typedocs
===============

Standard attributes for documenting types.

v1.0.0(1mo ago)0241MITPHPPHP >=8.2

Since Apr 26Pushed 1mo agoCompare

[ Source](https://github.com/n-fasano/php-typedocs)[ Packagist](https://packagist.org/packages/fasano/typedocs)[ RSS](/packages/fasano-typedocs/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (1)Dependencies (2)Versions (2)Used By (1)

Typedocs
========

[](#typedocs)

Standard attributes for documenting types in PHP.

Overview
--------

[](#overview)

Typedocs provides a set of PHP attributes that allow you to add human-readable documentation directly to your custom types. These attributes can be reflected at runtime to generate documentation, validate schemas, or provide metadata for API documentation.

Installation
------------

[](#installation)

```
composer require foundation/typedocs
```

Available Attributes
--------------------

[](#available-attributes)

### `#[Name]`

[](#name)

A human-readable name for the type.

### `#[Example]`

[](#example)

Example(s) of valid value(s) for the type.

### `#[Description]`

[](#description)

A detailed description of what the type represents.

Usage
-----

[](#usage)

```