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"
Labels:

Comments

Post a Comment

Popular posts from this blog

Beginner Java Exercise: Sentinel Values and Do-While Loops

In my previous post on while loops, we used a loop-continuation-condition to test the arguments. In this example, we'll loop at a sentinel-controlled loop. The sentinel value is a special input value that tests the condition within the while loop. To jump right to it, we'll test if an int variable is not equal to 0. The data != 0 within the while (data != 0) { ... } is the sentinel-controlled-condition. In the following example, we'll keep adding an integer to itself until the user enters 0. Once the user enters 0, the loop will break and the user will be displayed with the sum of all of the integers that he/she has entered. As you can see from the code above, the code is somewhat redundant. It asks the user to enter an integer twice: Once before the loop begins, and an x amount of times within the loop (until the user enters 0). A better approach would be through a do-while loop. In a do-while loop, you "do" something "while" the condition
12 comments
Read more

Programming Language Concepts Questions/Answers Part 3

1. What is an associative array? - An unordered collection of data elements that are indexed by keys. 2. Each element of an associative array is a pair consisting of a _______ and a _______. - key and a value 3. True or False? Java supports associative arrays? - True. As a matter of fact, Perl, Python, Ruby, C++, C# and F# do too. 4. What are associative arrays called in Perl? - hashes 5. Why are associative arrays in Perl called hashes? - Because their elements are stored and retrieved with a hash function 6. What character does a hash in Perl begin with? % 7. In Perl, each key is a _____ and each value is a _______. - string - scalar 8. In Perl, subscripting is done using _______ and _______. - braces and keys 9. In Perl, how are elements removed from hashes? - using delete 10. In Perl, the ________ operator tests whether a particular value is a key in a hash. - exists 11. What are associative arrays called in Python? - dictionaries 12. What is a dif
6 comments
Read more

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 find(Object x);  
50 comments
Read more