From 6fad9bc777b1dd64567b12b79ddef785deae1fec Mon Sep 17 00:00:00 2001 From: Jeff Teunissen <deek@d2dc.net> Date: Mon, 25 Jul 2011 15:52:24 -0400 Subject: [PATCH] Misc. doc sanitation Slightly document some of the vector types, and fix some typos. --- include/QF/progs.h | 10 +++++----- include/QF/qtypes.h | 6 +++--- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/include/QF/progs.h b/include/QF/progs.h index c3e4ab387..7affaaf2a 100644 --- a/include/QF/progs.h +++ b/include/QF/progs.h @@ -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 diff --git a/include/QF/qtypes.h b/include/QF/qtypes.h index 7a866e15f..a5a92cd45 100644 --- a/include/QF/qtypes.h +++ b/include/QF/qtypes.h @@ -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;