Download the PHP package klitsche/dog without Composer
On this page you can find all versions of the php package klitsche/dog. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Vendor klitsche
Package dog
Short Description Source code documentation generator for PHP libraries
License MIT
Homepage https://klitsche.github.io/dog/
Package dog
Short Description Source code documentation generator for PHP libraries
License MIT
Homepage https://klitsche.github.io/dog/
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
Informations about the package dog
Dog
Dog is a slim source code documentation generator for PHP libraries. It´s a thin layer around phpdocumentor/reflection and twig.
WIP: Expect breaking changes along all 0.* pre-releases.
Features
- Easily generates source code documentation
- Looks into code and phpdoc
- Helps to optimize code and phpdoc for documentation with customizable rules (based on proposed PSR-19)
- Outputs markdown (e.g. for use with mkdocs-material)
- Analyzes source code PHP ^5.2
- Provides support for custom printer logic & easy templating (planned)
- Provides support for custom enricher logic to add relevant & related data
Runtime Requirements
- PHP ^8.0
Suggested:
- json extension to enrich
phplocdata - simplexml extension to enrich
clovercoverage data
Quick Start
Add to your project:
composer require --dev klitsche/dogCreate config file .dog.yml in your project root directory and edit it.
Example:
Analyze code and phpdoc first, then generate documentation:
vendor/bin/dogAnalyze code & phpdoc and find potential documentation issues without generating documentation:
vendor/bin/dog --analyzeGenerate documentation without analyzing it first:
vendor/bin/dog --generateDocumentation
https://klitsche.github.io/dog/
Todos
- [x] Add code style checks
- [x] Add GitHub actions
- [x] Add cmd interface for dog bin
- [x] Add validation rules
- [x] Add documentation (mkdocs, github page)
- [x] Add tests
- [x] Add support for printer config - eg. templatePath
- [x] Add phar packaging
- [ ] Improve description printing - (inheritDoc, inline tags, ...)
- [ ] Add direct element interface for proposed PSR-19 tags
- [ ] Add phive packaging
All versions of dog with dependencies
PHP Build Version
Package Version
Requires
php Version
^8.0
phpdocumentor/reflection Version ^4.0 || ^5.0
twig/twig Version ^3.0
symfony/console Version ^5.0 || ^6.0
symfony/event-dispatcher Version ^5.0 || ^6.0
symfony/filesystem Version ^5.0 || ^6.0
symfony/finder Version ^5.0 || ^6.0
symfony/stopwatch Version ^5.0 || ^6.0
symfony/yaml Version ^5.0 || ^6.0
phpdocumentor/reflection Version ^4.0 || ^5.0
twig/twig Version ^3.0
symfony/console Version ^5.0 || ^6.0
symfony/event-dispatcher Version ^5.0 || ^6.0
symfony/filesystem Version ^5.0 || ^6.0
symfony/finder Version ^5.0 || ^6.0
symfony/stopwatch Version ^5.0 || ^6.0
symfony/yaml Version ^5.0 || ^6.0
The package klitsche/dog contains the following files
Loading the files please wait ....