PHPackages                             osushi/apidoc - 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. osushi/apidoc

ActiveLibrary[API Development](/categories/api)

osushi/apidoc
=============

API markdown document generator

0.2.0(4y ago)32.8kMITPHPPHP >=7.2.5 || ~8.0.0

Since Nov 28Pushed 4y ago1 watchersCompare

[ Source](https://github.com/Osushi/apidoc)[ Packagist](https://packagist.org/packages/osushi/apidoc)[ Docs](https://github.com/Osushi/apidoc)[ RSS](/packages/osushi-apidoc/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (11)Used By (0)

apidoc
------

[](#apidoc)

Generate markdown documentation from your code.

Requirements
------------

[](#requirements)

- `php` >=7.2.5 || ~8.0.0

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

[](#installation)

```
$ composer require --dev osushi/apidoc
```

Usage examples
--------------

[](#usage-examples)

### Script

[](#script)

#### 1. Create script file

[](#1-create-script-file)

```
$ mkdir docs
$ touch apidoc.php
```

#### 2. Edit code

[](#2-edit-code)

```