PHPackages                             liquid-edge/documentor - 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. liquid-edge/documentor

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

liquid-edge/documentor
======================

Useful addon methods for Nova

1.0.2(1y ago)0143PHP

Since Feb 25Pushed 1y ago1 watchersCompare

[ Source](https://github.com/ryno-liquidedge/Documentor)[ Packagist](https://packagist.org/packages/liquid-edge/documentor)[ RSS](/packages/liquid-edge-documentor/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (4)Used By (0)

Documentor README
=================

[](#documentor-readme)

Overview
--------

[](#overview)

`Documentor` is a PHP class designed to automatically generate Markdown documentation for a specified class. It utilizes reflection and a custom `ClassLoader` factory to extract information about class methods and format them into clean and easily readable Markdown output.

This package is part of the `LiquidedgeApp` namespace and enables developers to automate the process of creating class-level documentation in a user-friendly format.

---

Features
--------

[](#features)

- **Automated Markdown Documentation**: Generate Markdown documentation for all methods of a specified class.
- **Reflection-Based Analysis**: Leverage PHP Reflection to extract detailed information about class methods.
- **Extensibility**: Built with a factory-based `ClassLoader`, enabling easy extension and customization.

---

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

[](#installation)

1. Clone the repository from GitHub to your local environment:

```
git clone https://github.com/your-username/your-repo-name.git
```

2. Make sure your project meets the following requirements:

    - PHP 8.3 or later
    - A compatible autoloader (e.g., Composer) for the `LiquidedgeApp` namespace.
3. Include the class into your project via autoloading or manual inclusion:

```
use LiquidedgeApp\Documentor\Documentor;
```

---

Usage
-----

[](#usage)

1. Instantiate the `Documentor` class:

```
$documentor = new \LiquidedgeApp\Documentor\Documentor();
```

2. Pass the fully qualified name of the target class to the `create_markdown_doc()` method to generate Markdown documentation:

```
try {
       $classname = 'Namespace\YourClassName';
       $documentation = $documentor->create_markdown_doc($classname);
       echo $documentation; // Print or save the generated Markdown content
   } catch (\ReflectionException $e) {
       echo 'Error: ' . $e->getMessage();
   }
```

---

Example
-------

[](#example)

If the target class has methods like the following:

```
namespace MyApp;

class Example {
    public function methodOne() {
        // ...
    }

    public function methodTwo($param) {
        // ...
    }
}
```

Running the `create_markdown_doc()` will generate Markdown similar to this:

```
### methodOne

**Parameters**: None
**Description**: No details provided.

---

### methodTwo

**Parameters**:
- `$param`

**Description**: No details provided.
```

You can customize the generated documentation format by modifying the `ClassLoader` factory logic.

---

Exception Handling
------------------

[](#exception-handling)

- **`\ReflectionException`**: Thrown when there are issues with PHP Reflection, such as invalid class names or inaccessible methods.

---

Contributing
------------

[](#contributing)

Feel free to contribute to this repository by submitting issues, feature requests, or pull requests. To contribute:

1. Fork the repository.
2. Create a new branch for your feature: `git checkout -b feature-name`.
3. Commit your changes: `git commit -m 'Add some feature'`.
4. Push the branch: `git push origin feature-name`.
5. Open a pull request.

---

License
-------

[](#license)

This project is licensed under the MIT License. See the `LICENSE` file for more information.

---

Future Improvements
-------------------

[](#future-improvements)

- Add support for more detailed class property documentation.
- Include an option to specify custom Markdown templates.
- Support for documenting private and protected methods.
- CLI tool for easier generation of class documentation.

---

Contact
-------

[](#contact)

For further questions or assistance, please contact the repository owner or open an issue on GitHub.

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance46

Moderate activity, may be stable

Popularity10

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity40

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

3

Last Release

447d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/abdefd19bc827b3f998529fe0d6354e7851343db472511097979847b8c650936?d=identicon)[ryno-liquidedge](/maintainers/ryno-liquidedge)

---

Top Contributors

[![ryno-liquidedge](https://avatars.githubusercontent.com/u/126059897?v=4)](https://github.com/ryno-liquidedge "ryno-liquidedge (5 commits)")

### Embed Badge

![Health badge](/badges/liquid-edge-documentor/health.svg)

```
[![Health](https://phpackages.com/badges/liquid-edge-documentor/health.svg)](https://phpackages.com/packages/liquid-edge-documentor)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)