Generate 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

Peter Schulz is a lecturer in information technology at the HAN university of applied sciences. He is an experienced programmer with more than 25 years experience in Oracle databases and tools. Peter is the developer of WordPress plugin WP Data Access.

Leave a Reply

Your email address will not be published. Required fields are marked *