Space Colonizers:Documentation

From Grifkuba General Wiki
Jump to navigation Jump to search

code template

documentation

File

/**************************************
 *                                    *
 *          Filename.txt              *
 *                                    *
 *    contains the filename class     *
 *      fields and functions          *
 **************************************/

Class

introduction

- name - basic details - fields - functions - other

	/***********************
	 * Name: 
	 * Purpose: 
	 * Fields:
	 *	
	 * Functions:
	 *	
	 * Other Details:
	 *   
	 ***********************/

Functions

- name - input - parameter details - output - returns

/*
 * Name:
 * Purpose:
 * Input:
	**
	** 
 * Output:
	**
    **
 * Sample:
	** 
 * Other Details:
 */