Coding conventions

General rules

End of lines

ET:L uses Unix style EOL across the whole project. Refer to Configure git to deal with lines ending to avoid mixing Windows and Unix style EOL.

Function headers

In order to get Doxygen working with our codebase, please start changing the old function comment headers to the following format:

OLD:

/*
=================
FS_ConditionalRestart
restart if necessary

FIXME: this doesn't catch all cases where an FS_Restart is necessary
=================
*/

NEW: Note 2x* in the beginning

/**
 * @brief Restart if necessary.
 * @todo this doesn't catch all cases where an FS_Restart is necessary
 */

If the comment is inside the function, you can use // FIXME: and // TODO: etc.

Mac OS X specific parts

#ifdef __APPLE__ - this is a standard preprocessor definition used by Apple. It should be used from now on in all Mac-specific code.

#ifdef __MACOS__ - this preprocessor definition was never used by ET: Legacy. Parts of the code encapsulated by it were not even migrated from the vanilla source code to raedwulf-et, e.g. Sys_PumpEvents();. Therefore, it was removed in ee04dd00.

check if W:ET 2.60b mods expect the Mac binary to be identified with the removed CPUSTRING OSX-universal or if we can use the new one.

#ifdef MACOS_X - now replaced by the standard __APPLE__ define