Download the PHP package irazasyed/docgen without Composer

On this page you can find all versions of the php package irazasyed/docgen. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

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:
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.
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?

Example code of irazasyed/docgen

Informations about the package docgen

Docgen for Laravel Facade

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

📖 Streamline your Laravel package development with automatic facade documentation using Docgen for Laravel Facade.

Docgen

Introduction

Docgen for Laravel packages, the ultimate solution for Laravel package developers.

This heroic package automatically generates documentation for your Laravel package facade, eliminating the tedious task of maintaining it yourself.

With this package, IDEs will provide you and the developers using your package with method suggestions, making your development journey a breeze.

Installation

You can install the package via composer:

Usage

There are a number of ways to use the CLI tool.

Basic

Let's start with the basic usage.

Call the command with the name of the facade:

Advanced

Create a new config file in your package's root directory named docgen.php and add the following code:

Run the following command to generate the documentation and apply it to the facade:

You can also store the config file elsewhere and provide the path using the -c or --config option.

Example:

Generate Docs for Multiclass Facade

If your Laravel facade is linked to a chain of classes that require documentation, you can provide an array of class names. Additionally, if you want to exclude certain methods from the documentation of a specific class, you can pass an array containing the names of those methods.

To illustrate, consider the following example which demonstrates how to use this approach with the Telegram Bot SDK's Laravel Facade:

Call the command to generate and apply the docs.

API

generate(string|array $classes, array $globalExcludedMethods = [])

Generate the documentation for given classes.

Parameters

Returns

Docgen - The Docgen instance.

Example

getDocBlock()

Get the generated documentation.

Returns

string - The generated documentation.

apply(string $className = '')

Apply the generated documentation to the given class name or defaults to the class used to generate docs.

Parameters

Returns

bool - True if it was successful, false otherwise.

TODO

Resources

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

All versions of docgen with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package irazasyed/docgen contains the following files

Loading the files please wait ....