Skip to main content

How to Install and use phpDocumentor

If you have Windows, and are running WAMP, this is the step by step installation guide to getting phpDocumentor to work. This write-up assumes that you have WAMP installed and working.

  1. Download Composer from https://getcomposer.org/
  2. Run through the installation with the default settings. It will locate php for you automatically. If you're having any issues with the install, Google the response. There shouldn't be any errors though.
  3. If you have CMD opened, close it now.
  4. Open CMD and type in composer. If something starts happening, Composer is installed correctly.
  5. Go to the directory that you want to install phpDocumentor.
  6. In your project directory, create a JSON file. Name it, composer.json and add the following code to it
    {
        "require-dev": {
            "phpdocumentor/phpdocumentor": "2.*"
        }
    }
  7. For example, let's say that your project directory is located in C:/wamp/www/your_project, you're going to want to open CMD and make sure that you've navigated to that directory. Remember cd ../ to move up a directory. If you're in C:/ then type in cd C:/wamp/www/your_project to get into that directory.
  8. Now type composer install
  9. This will take some time (usually less than a couple of minutes) but will install a new directory called vendor
  10. In CMD, type in cd vendor/bin. You're going to be in C:\wamp\www\your_project\vendor\bin
  11. Now you can type in phpdoc followed by a command
  12. If you want to create documentation for a single file, you'll use -f. If you want to create documentation for the entire directory, you'll use -d
  13. You're going to want to follow it with a -t that states where the documentation will be going. Create a docs folder in C:\wamp\www\your_project\docs.
  14. The last segment that you have a choice of appending is --template. Go to https://www.phpdoc.org/templates to get the available templates. i.e. clean
  15. For example, to create documentation for a file go to CMD and in the bin directory, type phpdoc -f "C:\wamp\www\your_project\classes\some_class.php" -t "C:\wamp\www\your_project\docs" --template "responsive-twig"
  16. To create documentation for the entire directory, type in the following: phpdoc -d "C:\wamp\www\your_project\classes" -t "C:\wamp\www\your_project\docs" --template "responsive-twig"

Comments

Post a Comment

Popular posts from this blog

Laravel 6.x with React and react-router

This will get you started on getting your first React/Laravel application deployed to your server. We'll cover everything from installation to deployment. Start by reading the installation instructions on  https://laravel.com/docs/6.x#installing-laravel . We'll cover those details below. Setting Up Laravel Check that you have the latest version of PHP installed on your computer.  It must be >= 7.2.0. Open terminal to get the Laravel installation tool. Type in composer global require laravel/installer Type in laravel to verify installation. Navigate to a directory on your computer where you want to install your project on your terminal. Run the following command: laravel new project_name (replace project_name with your project name). Once complete, cd into your new project. Type the following command: php artisan serve. You'll get a message like the following if it's running successfully: Laravel development server started: http://127.0.0.1:8000 ...

Creating your own ArrayList in Java

Wanted to show that certain data structures in Java can be created by you. In this example, we'll go ahead and create an ArrayList data structure that has some of the methods that the built in ArrayList class has. We'll create 2 constructors: The default constructor that creates an ArrayList with a default size of 10. Constructor that allows an initial size to be passed to the array. We'll also create a number of methods: void add(Object x);  A method that allows you to place an Object at the end of the ArrayList. void add(int index, Object x);  A method that allows you to place a value at a given location. Object get(int index):  Allows you to retrieve a value of the arrayList array from a given location. int size();  Allows you to get the number of elements currently in the Arraylist. boolean isEmpty();  Tests to see if the Arraylist is empty. boolean isIn(Object x);  A method that sees if a particular object exist in the arrayList. int ...

Programming Language Concepts Test Questions/Answers

One of the easiest methods that I use to learn new topics is by creating notes on the subject and then by turning those notes into questions and answers. Remembering answers to questions just seems more natural. I was able to memorize 323 questions and answers in a matter of a couple of days. I wanted to start doing this for some topics that I find pretty interesting. To begin, here are some questions and answers to Programming Language Concepts (PLC). I'm reading your mind right now and the answer is yes, there will be more. 1. Name 3 reasons for studying PLC. - Better understanding of current programming languages - Advancement of computing - Increased capability to express ideas - Increased capability to learn new programming language. - Better understanding of which programming language to choose.  2. Name the 5 programming domains and languages best suited for each. - Scientific (Fortran, ALGOL 60) - Business (COBOL) - AI (Lisp, Scheme, Prolog) - Web (PHP, ...