Download the PHP package world-warm-worm/autodoc without Composer
On this page you can find all versions of the php package world-warm-worm/autodoc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download world-warm-worm/autodoc
More information about world-warm-worm/autodoc
Files in world-warm-worm/autodoc
Package autodoc
Short Description Generates documentation of classes methods in several file formats
License Apache-2.0
Homepage https://github.com/worldWarmWorm/autodoc
FAQ
Example:
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 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.
Informations about the package autodoc
Yo! 
What can a library do?
Documents methods of any class, regardless of access modifiers, in two json and yaml formats. All you need to
do is call the constructor of the JsonAutodoc or YamlAutodoc class, throw an object of the class into it, the
methods of which need to be documented and comply with the requirement that the documented class implement the
EndpointInterface interface. Where can I call the constructor of the JsonAutodoc or YamlAutodoc class? It depends
on your needs. For example, I'm in my project the JsonAutodoc constructor was called in the constructor body of the
class, which is an API for a third-party service. This way, the documentation is reassembled every time the API
endpoint is called and is always up to date.
Hou to use?
Usage examples
/tests/EndpointAutodocTest.php
/src/Api/Product/Controller/ProductController.php
What if my project is written on the symfony/laravel/yii framework?
The library is easily integrated. You can use this approach: if you work on any of the modern MVC frameworks, then generate your own documentation file for each controller. Select another controller, where there will be a list links to the documentation of all other controllers as in the example with the file index.php this library. This way it will be possible for any of the colleagues on the project (not just the programmer) to have an idea of how the controllers in the project or API work.
What if I want to use your library, but my project doesn't have composer?
Download the zip from my repository and unzip the library folder. To work with the library, you will only
need the /src/Autodoc folder, but it uses the namespaces specified in /composer.json in its files. The files may
not be located in your project. Most likely, you will need to replace the library's namespaces with your own.
That's all
If you want to join to develop this project - you are welcome in pull requests. If you find smth not working you are welcome to issues.
Find me in telegram or email.
