PHPackages                             thecichos/auto-documentation - 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. [API Development](/categories/api)
4. /
5. thecichos/auto-documentation

ActiveLibrary[API Development](/categories/api)

thecichos/auto-documentation
============================

Automatic API and code documentation generation using PHPdocs

26[6 issues](https://github.com/thecichos/AutoDocumentation/issues)PHP

Since Jan 9Pushed 4mo agoCompare

[ Source](https://github.com/thecichos/AutoDocumentation)[ Packagist](https://packagist.org/packages/thecichos/auto-documentation)[ RSS](/packages/thecichos-auto-documentation/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

documentation for auto documentation
====================================

[](#documentation-for-auto-documentation)

This documentation was autogenerated using this tool

Table of Contents
-----------------

[](#table-of-contents)

### Types

[](#types)

- **AutoDocumentation**
    - [AutoDocumentation](#AutoDocumentation-type-auto-documentation)
- **Generator**
    - [PropertyInfo](#PropertyInfo-type-property-info)
    - [TypeInfo](#TypeInfo-type-type-info)
    - [TypeRegistry](#TypeRegistry-type-type-registry)
    - [MethodParamInfo](#MethodParamInfo-type-method-param-info)
    - [Accessibility](#Accessibility-type-accessibility)
    - [DocGenerator](#DocGenerator-type-doc-generator)
    - [MethodInfo](#MethodInfo-type-method-info)
    - [TypeRenderer](#TypeRenderer-type-type-renderer)

---

Type Reference
--------------

[](#type-reference)

### PropertyInfo {#type-property-info}

[](#propertyinfo-type-property-info)

Represents metadata about a class property for documentation purposes

**Fully Qualified Name:** `AutoDocumentation\Generator\PropertyInfo`

**Properties:**

VisibilityPropertyTypeDescriptionPublic`name``string`The name of the propertyPublic`type``string`The type of the property as a stringPublic`nullable``bool`Whether the property can be nullPublic`description``string`Human-readable description of the propertyPublic`example`?`mixed`Example value for the propertyPublic`deprecated``bool`Whether the property is deprecatedPublic`accessibility`[`Accessibility`](#Accessibility-type-accessibility)Visibility level of the property---

### TypeInfo {#type-type-info}

[](#typeinfo-type-type-info)

Represents metadata about a class or interface for documentation purposes

**Fully Qualified Name:** `AutoDocumentation\Generator\TypeInfo`

**Properties:**

VisibilityPropertyTypeDescriptionPublic`fqcn``string`Fully qualified class name of the typePublic`shortName``string`Short class name without namespacePublic`slug``string`URL-friendly identifier for the typePublic`group``string`Category group for organizing types in documentationPublic`description``string`Human-readable description of the typePublic`properties``array`List of property definitions for this typePublic`methods``array`List of method definitions for this type**Methods:**

VisibilityMethodDescriptionReturnsPublic`getAnchor()`Returns a Markdown anchor for this type`string`Public`getUrl()`Returns a URL for this type in the documentation`string`---

### TypeRegistry {#type-type-registry}

[](#typeregistry-type-type-registry)

Registry for tracking documented types and resolving type links

**Fully Qualified Name:** `AutoDocumentation\Generator\TypeRegistry`

**Properties:**

VisibilityPropertyTypeDescriptionPrivate`types``array