ShuriZma
/
fceux
mirror of https://github.com/TASEmulators/fceux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

sdl: added code style guidelines

This commit is contained in:
punkrockguy318 2012-03-06 13:03:08 +00:00
parent 5b14f342bd
commit 2badc32d6c
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
STYLE-GUIDELINES-SDL.md Normal file
View File

@ -0,0 +1,14 @@
FceuX-SDL Style Guidelines
=========================
Background
----------
While you may think having style guidelines specific to a directory in a sourcetree is outrageous, fceuX has a unique elaborate history of the code. I (prg318) have ressurected the majority of the SDL port code and tried to keep some aspects of the style consistant (although not many aspects were that consistent to begin with due to the amount of different people who have contributed to this codebase). The SDL port alone consists of over 8,000 lines of C++ code, much of which is compliant to these guidelines so please use this guidelines when going forth and writing code in src/drivers/sdl. *Following these simple rules will make it a lot easeier for the developers to accept your patch.*
Tabs
----
Hard tabs only! Please! src/drivers/sdl/* entirely consists of hard tabbed code. Please continue to use this contention. Consult the documentation of your text editor documentation for instructions on how to this with your editor.
Return Statements
-----------------
Please use the "return 0;" style return statements instead of the "return(0)" style return statements.