qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2025-01-31 05:00:35 +00:00
Code Issues Projects Releases Packages Wiki Activity

Misc. doc sanitation

Browse source 
Slightly document some of the vector types, and fix some typos.
This commit is contained in:
Jeff Teunissen 2011-07-25 15:52:24 -04:00
parent 49b5940cd5
commit 6fad9bc777
2 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
include/QF/progs.h
View file

@ -296,7 +296,7 @@ void PR_Undefined (progs_t *pr, const char *type, const char *name) __attribute_
/** \defgroup prda_globals Globals
\ingroup progs_data_access
Typed global access marcos. No checking is done against the QC type, but
Typed global access macros. No checking is done against the QC type, but
the appropriate C type will be used.
*/
//@{
@ -486,7 +486,7 @@ void PR_Undefined (progs_t *pr, const char *type, const char *name) __attribute_
/** \defgroup prda_parameters Parameters
\ingroup progs_data_access
Typed parameter access marcos. No checking is done against the QC type, but
Typed parameter access macros. No checking is done against the QC type, but
the appropriate C type will be used.
*/
//@{
@ -843,7 +843,7 @@ void PR_Undefined (progs_t *pr, const char *type, const char *name) __attribute_
/** \defgroup prda_entity_fields Entity Fields
\ingroup progs_data_access
Typed entity field access marcos. No checking is done against the QC type,
Typed entity field access macros. No checking is done against the QC type,
but the appropriate C type will be used.
*/
//@{
@ -1077,7 +1077,7 @@ int PR_RelocateBuiltins (progs_t *pr);
Strings management functions.
All strings accessable by the VM are stored within the VM address space.
These functions provide facilities to set permanent, dynamic and
These functions provide facilities to set permanent, dynamic and
temporary strings, as well as mutable strings using dstrings.
Permanent strings are either supplied by the progs (+ve string index) or
@ -1175,7 +1175,7 @@ void PR_MakeTempString(progs_t *pr, string_t str);
string_t PR_NewMutableString (progs_t *pr);
/** Make a dynamic progs string from the given C string. Will not create a
duplicate permanent string (temporary, dynamic and mutable strings are
duplicate permanent string (temporary, dynamic and mutable strings are
not checked).
\param pr pointer to ::progs_t VM struct
\param s C string to be made into a permanent progs string

6
include/QF/qtypes.h
View file

@ -67,10 +67,10 @@ typedef enum {false, true} qboolean;
#endif
// From mathlib...
typedef float vec_t;
typedef vec_t vec3_t[3];
typedef float vec_t; ///< The basic vector component type
typedef vec_t vec3_t[3]; ///< A 3D vector (used for Euler angles and motion vectors)
typedef vec_t vec4_t[4];
typedef vec_t quat_t[4];
typedef vec_t quat_t[4]; ///< A quaternion.
typedef vec_t vec5_t[5];
typedef int fixed4_t;
typedef int fixed8_t;