rudra/docs

Command line tool for generating markdown-formatted class documentation

v25.12 2025-10-17 08:35 UTC

Requires

• php: >=8.3
• rudra/cli: v25.12
• rudra/container: v25.12

MIT

• Jagepard

• generator
• markdown
• rudra

README

Rudra-Documentation-Collector | API

Install | Установка

composer require rudra/docs

Generate docs for all classes in a source directory | Создание документации для всех классов в каталоге

$ ./vendor/bin/rudra-docs

Добавить команду в Rudra-Framework config/commands.yml

make:docs:
  - Rudra\Markdown\Command\MakeDocumentation

Specify the path of the required folder with classes | Указываем путь необходимой папки с классами

Enter source directory: src or | или Enter source directory: vendor/rudra/cli

Specify the name of the output file .md | Указываем название выходного файла .md

Enter file name: api

License

This project is licensed under the Mozilla Public License 2.0 (MPL-2.0) — a free, open-source license that:

• Requires preservation of copyright and license notices,
• Allows commercial and non-commercial use,
• Requires that any modifications to the original files remain open under MPL-2.0,
• Permits combining with proprietary code in larger works.

📄 Full license text: LICENSE
🌐 Official MPL-2.0 page: https://mozilla.org/MPL/2.0/

Проект распространяется под лицензией Mozilla Public License 2.0 (MPL-2.0). Это означает:

• Вы можете свободно использовать, изменять и распространять код.
• При изменении файлов, содержащих исходный код из этого репозитория, вы обязаны оставить их открытыми под той же лицензией.
• Вы обязаны сохранять уведомления об авторстве и ссылку на оригинал.
• Вы можете встраивать код в проприетарные проекты, если исходные файлы остаются под MPL.

📄 Полный текст лицензии (на английском): LICENSE
🌐 Официальная страница: https://mozilla.org/MPL/2.0/