Tip:
Highlight text to annotate it
X
Welcome to the screencast about the phpDocumentor ingeration into PHPEdit.
phpDocumentor is a PHP project which provides you the tools to create an API reference for your projects.
It will create documentations in various output formats and display you for example the dependencies or classes, a list of class methods, functions, constants and much more.
For a complete list of features please visit the website of the phpDoc team.
When we look into the PHP file, on which the documentation is based on, we will find similar information.
For example we see that the class “DBMySQL” extends the class “DBAdapter”.
The same information is available inside the documentation.
The first method inside the file is “toUpperCase”, and we will find that method inside the documentation, too.
There are some common tags which helps phpDoc to get even more information from your files.
They start with an @ sign, followed by a known keyword.
For example the @version tag displays a version of this class, file or even method.
You can use the @copyright or @author statement to give information about the creator of the content.
@since gives you the possibility to add information about the version or time when the specific feature or method was added.
@package allows you to group different packages, which can be browsed separately inside the documentation.
All this tags are global features, so they can be added to a file, a class, a method or a function.
phpDoc also supports some special tags which are related to methods or functions.
For example the @param tag allows you to define the expected type, the name and a description of each parameter.
The @return tag allows you to specify a return type and an additional description.
The @see allows you to create references to other methods, classes or PHP functions.
If you would like to see a more complete list of tags, please take a look at the phpDocumentor manual.
To create the documentation, PHPEdit provides an easy to use wizard. You can choose a project name, the output format, the template and even some special options for the creation process.
After you have defined on which files and folders the documentation should be based on you need to specify your output directory.
There are no more informations needed, and PHPEdit is able to create the documentation for you.
The creation may take a while, based on the size of the project.
After the process is finished, you can open the documentation directly inside PHPEdit and browse the files in a more efficient way.