Add this template before functions in a library, in order to give a good description of what it is and what it does. Replace all in < and > with your values.
- Function: <Function, ex. my_function( $param1, $param2 )>
- Description: <Description of what it does>
- Parameters: <Parameters for function>
- Example: <Show an example of your function in use, ex. my_function( "thisparameter", "newparameter");>
- Requirements: <Anything that your function requires>
- Notes: <Any other comments you have>
- Author: <your name and email/website address>
You need to login to post a comment.