Raesquiv13 / gpos-System

Sistema de punto de venta
1 stars 0 forks source link

Apply documentation in code #26

Closed Raesquiv13 closed 4 years ago

Raesquiv13 commented 4 years ago

As the product owner, I want to:

Document each function in all the project, you use as much information as necessary.

Follow the structure as standard and keep it along the project.

To document functions.

/**
 *** This function is used to: 
  *
  *
 *** Information about parameters
  ** @param (variable name) (information about the parameter)
  *
**/

To document routes

/**
 * This API provide us:
 * 
 * 
 * API REST method
 * @method 
 * 
 * URL request
 * @var URL = 
 * 
 * Controller name
 * @var 
 *  
 * Function name
 * @function 
 **/
Raesquiv13 commented 4 years ago

QA

It is not required for this US