Quake 2 Oop conversion project - Documentation Standard


Documentation Standard ( back to table of contents ) :  
All files :
The top of the file should look like the following :  
// Filename : myfile.cpp
// Author : My Name
// Author Email : myemail@myisp.com
// Description  : Short / or lengthy description of files purpose.
// Required Headers : Other files ( includes ) that are needed by this file to operate.
 
Header files : 

Encapsulating the header there needs to be a define header name sequence that looks like the following. Where the myheader_h is replaced by the filename of the 
header preceded by a underscore and postfixed with a underscore. Id's original code should be at the top of the file commented out, or you can have a section that states lines blah to blah made redundant in file, please note the original  
file should also have a replaced notice, so this would look like so : 

// edict_t.h - 567 to 980 - Replaced All code with this below.  

Make comments within the header of the items changed / rewritten from the original source. 

#ifndef _myheader_h_  
#define _myheader_h_  

//Header Code  

#endif // Close off the #ifndef  
 

Cpp / C files : 

Encapsulating the c / cpp file there needs to be a define file sequence that looks like the following. Where the mycfile_c is replaced by the filename of the 
c / cpp file preceded by a underscore and postfixed with a underscore. Id's original code should be at the top of the file commented out. Id's original code should be at the top of the file commented out, or you can have a section that states lines blah to blah made redundant in file, please note the original  
file should also have a replaced notice, so this would look like so : 

// edict_t.h - 567 to 980 - Replaced All code with this below.  

Make comments within the header of the items changed / rewritten from the original source. 
 

#ifndef _mycfile_c_  
#define _mycfile_c_  

//C / Cpp Code  

#endif