Hi friends, in this post I am going to explain about the how to create documentation for php application. In the earlier post explained about how to write a webservices using php with json format. For that post I have written documentations for each and every code.
This documentation will be useful when we are going to upgrade the code or maintenance the application. Documentation will covers the following points.
1. Purpose of Application or Project
2. Which classes are used
3. How many files are used
4. Explained the class with how many methods and properties are used
5. Explained detailed information about each method with parameters
Detailed explanation with an example
1. Purpose of Application or Project
This is for how to write a web services using php with the json format. Now a days mobile applications are more popular. Most of mobile applications are implementing for existing websites. To isplay information from database to mobile one mediator is require. So that mediator implementing using php and the output as JSON format to easy to retrieve.
2. Which classes are used
Users class
3. How many files are used
getresults.php
4. Explained the class with how many methods and properties are used
Methods : __construct() , login()
Properties : $username , $password, $connection
5. Explained detailed information about each method with parameters
Method : __construct( $username, $password)
Method : login( $connection, $database, $table, $usernameField, $passwordField)
In detailed explained in the attached html file.
Pingback : How to write a webservices using php with json format - Anil Labs
Pingback : How to call API in CakePHP - Anil Labs