I would like to add some documentation comments for my (PHP) class and its functions in some standard format so that its easier for others to understand.
I will appriciate if you can give me an example that how you would write comments for following class and function? Thanks.
Info about class:
Classname Photos: it has some functions related to uploading the photo and displaying the photos. function names are upload()
, display()
, delete()
.
Info about upload function:
uploads the resizes and uploads the image and has few parameters as shown below.
<?php
class Photos extends CI_Controller
{
public function upload($file_name, $new_name, $new_width, $new_height, $directory)
{
...
...
returns true or false.
}