doxygen.h File Reference

Macros to abstract compiler capabilities (for doxygen use only) More...

Go to the source code of this file.

Macros
#define	SCP_FORMAT_STRING
	Identifies a printf-style format string. More...
#define	SCP_FORMAT_STRING_ARGS(formatArg, varArgs)
	Specify which arguments are involved in printf-style string formatting. More...
#define	SIZE_T_ARG   "%zu"
	Format specifier for a size_t argument. More...
#define	PTRDIFF_T_ARG   "%zd"
	Format specifier for a ptrdiff_t argument. More...

Detailed Description

Macros to abstract compiler capabilities (for doxygen use only)

Definition in file doxygen.h.

Macro Definition Documentation

#define PTRDIFF_T_ARG   "%zd"

Format specifier for a ptrdiff_t argument.

Due to different runtimes using different format specifier for these types it's necessary to hide these changes behind a macro. Use this in place of zd

Definition at line 46 of file doxygen.h.

#define SCP_FORMAT_STRING

Identifies a printf-style format string.

Definition at line 18 of file doxygen.h.

#define SCP_FORMAT_STRING_ARGS	(		formatArg,
			varArgs
	)

Specify which arguments are involved in printf-style string formatting.

Expands to a compiler specific attribute which specify where the format arguments are located. Parameters are 1-based which also includes the 'this' parameter at position 1 for class methods.

Parameters

formatArg	Location of format string argument in the argument list
varArgs	Location where the variable arguments begin

Definition at line 30 of file doxygen.h.

#define SIZE_T_ARG   "%zu"

Format specifier for a size_t argument.

Due to different runtimes using different format specifier for these types it's necessary to hide these changes behind a macro. Use this in place of zu

Definition at line 38 of file doxygen.h.