Plugin API Documentation

Generate API Documentation

  • Start the command line interface
  • Navigate to the plugin root folder
  • Enter the following commands:
    • composer require –dev phpdocumentor/phpdocumentor dev-master
    • php vendor/phpdocumentor/phpdocumentor/bin/phpdoc.php
  • Navigate to subfolder docs
  • Open file index.html in your favourite browser

Remove API Documentation

  • Start the command line interface
  • Navigate to the plugin root folder
  • Enter the following command:
    • composer remove –dev phpdocumentor/phpdocumentor
  • Delete subfolder docs
  • Delete file composer.lock
Was this article helpful to you? Yes No