Skip to content
Browse files

Doxygen and Luadoc fixes galore.

  • Loading branch information...
1 parent b0ebd05 commit d1bdc59a424ff476e0d3f03648e35d8c156a7642 @Deiz Deiz committed Jun 28, 2011
View
42 src/ai.c
@@ -11,8 +11,8 @@
*
* Concept: Goal (Task) Based AI with additional Optimization
*
- * AI uses the goal (task) based AI approach with tasks scripted in lua,
- * additionally there is a task that is hardcoded and obligatory in any AI
+ * AI uses the goal (task) based AI approach with tasks scripted in Lua,
+ * additionally there is a task that is hard-coded and obligatory in any AI
* script, the 'control' task, whose sole purpose is to assign tasks if there
* is no current tasks and optimizes or changes tasks if there are.
*
@@ -42,7 +42,7 @@
*
* The AI currently has per-pilot memory which is accessible as "mem". This
* memory is actually stored in the table pilotmem[cur_pilot->id]. This allows
- * the pilot to keep some memory always accesible between runs without having
+ * the pilot to keep some memory always accessible between runs without having
* to rely on the storage space a task has.
*
* Garbage Collector
@@ -449,7 +449,7 @@ static void ai_setMemory (void)
/**
- * @brief Sets the pilot for furthur AI calls.
+ * @brief Sets the pilot for further AI calls.
*
* @param p Pilot to set.
*/
@@ -1027,7 +1027,7 @@ void ai_getDistress( Pilot* p, const Pilot* distressed )
/**
* @brief Runs the create() function in the pilot.
*
- * Should create all the gear and sucth the pilot has.
+ * Should create all the gear and such the pilot has.
*
* @param pilot Pilot to "create".
* @param param Parameter to pass to "create" function.
@@ -1925,7 +1925,7 @@ static int aiL_isenemy( lua_State *L )
}
/*
- * checks if pillot is an ally
+ * checks if pilot is an ally
*/
static int aiL_isally( lua_State *L )
{
@@ -2815,7 +2815,7 @@ static int aiL_relvel( lua_State *L )
}
/*
- * completely stops the pilot if it is below minimum vel error (no instastops)
+ * completely stops the pilot if it is below minimum vel error (no insta-stops)
*/
static int aiL_stop( lua_State *L )
{
@@ -2828,7 +2828,7 @@ static int aiL_stop( lua_State *L )
}
/*
- * Tells the pilot's escort's to attack its target.
+ * Tells the pilot's escorts to attack its target.
*/
static int aiL_e_attack( lua_State *L )
{
@@ -3017,19 +3017,21 @@ static int aiL_getenemy_size( lua_State *L )
* @brief gets the nearest enemy within specified heuristic
*
* @luaparam Mass goal mass map (0-1)
- * @luaparam DPS goal DPS map (0-1)
* @luaparam HP goal HP map (0-1)
- * @luapa
+ * @luaparam DPS goal DPS map (0-1)
+ * @luaparam Range weighting for range (typically > 1)
* @luareturn the best fitting target
* @luafunc getenemy_heuristic( Mass, DPS, HP, range )
*/
static int aiL_getenemy_heuristic( lua_State *L )
{
unsigned int p;
- double mass_factor = 0, health_factor = 0, damage_factor = 0, range_factor = 0;
+ double mass_factor, health_factor, damage_factor, range_factor;
NLUA_MIN_ARGS(4);
+ mass_factor = health_factor = damage_factor = range_factor = 0;
+
mass_factor = luaL_checklong(L,1);
health_factor = luaL_checklong(L,2);
damage_factor = luaL_checklong(L,3);
@@ -3124,10 +3126,10 @@ static int aiL_canboard( lua_State *L )
}
/**
- * @brief Lua wrapper: Gets the relative size(shipmass) between the current pilot and the specified target
+ * @brief Lua wrapper: Gets the relative size (ship mass) between the current pilot and the specified target.
*
- * @param pilot_ID the ID of the pilot whose mass we will compare
- * @luareturn A number from 0 to 1 mapping the relative masses
+ * @param pilot_ID the ID of the pilot whose mass we will compare.
+ * @luareturn A number from 0 to 1 mapping the relative masses.
* @luafunc relsize( id )
*/
static int aiL_relsize( lua_State *L )
@@ -3150,10 +3152,10 @@ static int aiL_relsize( lua_State *L )
/**
- * @brief Gets the relative damage output(total DPS) between the current pilot and the specified target
+ * @brief Gets the relative damage output (total DPS) between the current pilot and the specified target.
*
- * @param pilot_ID the ID of the pilot whose DPS we will compare
- * @luareturn A number from 0 to 1 mapping the relative DPS's
+ * @param pilot_ID ID of the pilot whose DPS we will compare.
+ * @luareturn A number from 0 to 1 mapping the relative DPSes.
* @luafunc reldps( id )
*/
static int aiL_reldps( lua_State *L )
@@ -3176,10 +3178,10 @@ static int aiL_reldps( lua_State *L )
/**
- * @brief Gets the relative HP(total shields and armor) between the current pilot and the specified target
+ * @brief Gets the relative health (total shields and armour) between the current pilot and the specified target
*
- * @param pilot_ID the ID of the pilot whose HP we will compare
- * @luareturn A number from 0 to 1 mapping the relative HPs
+ * @param pilot_ID ID of the pilot whose health we will compare.
+ * @luareturn A number from 0 to 1 mapping the relative healths.
* relhp()
*/
static int aiL_relhp( lua_State *L )
View
4 src/array.h
@@ -139,7 +139,7 @@ __inline__ static void *_array_end_helper(void *a, size_t e_size)
*
* @param ptr_array Array being manipulated.
* @param first First iterator to erase.
- * @param last Last iteratior in erase section but is not erased.
+ * @param last Last iterator in erase section but is not erased.
*/
#define array_erase(ptr_array, first, last) \
(_array_erase_helper((void **)(ptr_array), sizeof((ptr_array)[0][0]), (void *)(first), (void *)(last)))
@@ -177,7 +177,7 @@ __inline__ static void *_array_end_helper(void *a, size_t e_size)
*/
#define array_reserved(array) (_array_private_container(array)->_reserved)
/**
- * @brief Returns a pointer to the begining of the reserved memory space.
+ * @brief Returns a pointer to the beginning of the reserved memory space.
*
* @param ptr_array Array being manipulated.
* @return Beginning of memory space.
View
2 src/background.c
@@ -84,7 +84,7 @@ static void bkg_sort( background_image_t *arr );
/**
- * @brief Initilaizes background stars.
+ * @brief Initializes background stars.
*
* @param n Number of stars to add (stars per 800x640 screen).
*/
View
4 src/claim.c
@@ -5,7 +5,7 @@
/**
* @file claim.c
*
- * @brief Handles claiming systems.
+ * @brief Handles claiming of systems.
*/
#include "claim.h"
@@ -132,7 +132,7 @@ void claim_destroy( SysClaim_t *claim )
/**
- * @brief Clears the claimings on all systems.
+ * @brief Clears the claims on all systems.
*/
void claim_clear (void)
{
View
2 src/collision.c
@@ -24,7 +24,7 @@
*
* @param[in] at Texture a.
* @param[in] asx Position of x of sprite a.
- * @param[in] asy Position of y of sprita a.
+ * @param[in] asy Position of y of sprite a.
* @param[in] ap Position in space of sprite a.
* @param[in] bt Texture b.
* @param[in] bsx Position of x of sprite b.
View
4 src/colour.c
@@ -105,7 +105,7 @@ glColour cFontNeutral = { .r = 1.0, .g = 0.9, .b = 0.0, .a = 1. }; /**< Neut
/**
- * @brief Changes colourspace from HSV to RGB.
+ * @brief Changes colour space from HSV to RGB.
*
* All values go from 0 to 1, except H which is 0-360.
*
@@ -146,7 +146,7 @@ void col_hsv2rgb( double *r, double *g, double *b, double h, double s, double v
/**
- * @brief Changes colourspace from RGB to HSV.
+ * @brief Changes colour space from RGB to HSV.
*
* All values go from 0 to 1, except H which is 0-360.
*
View
4 src/colour.h
@@ -12,7 +12,7 @@
/**
- * @brief reperesents a colour via its RGBA values.
+ * @brief represents a colour via its RGBA values.
*/
typedef struct glColour_ {
GLfloat r; /**< Red value of the colour (0 to 1). */
@@ -100,7 +100,7 @@ glColour* col_fromName( const char* name );
/*
- * Colourspace conversion routines.
+ * Colour space conversion routines.
*/
void col_hsv2rgb( double *r, double *g, double *b, double h, double s, double v );
void col_rgb2hsv( double *h, double *s, double *v, double r, double g, double b );
View
2 src/dev.c
@@ -5,7 +5,7 @@
/**
* @file dev.c
*
- * @brief Generic developement routines.
+ * @brief Generic development routines.
*/
#include "dev.h"
View
2 src/dev_outfit.c
@@ -5,7 +5,7 @@
/**
* @file dev_outfit.c
*
- * @brief Handles the outfit developement routines.
+ * @brief Handles the outfit development routines.
*/
#include "dev_outfit.h"
View
2 src/dev_ship.c
@@ -5,7 +5,7 @@
/**
* @file dev_ship.c
*
- * @brief Handles the ship developement routines.
+ * @brief Handles the ship development routines.
*/
#include "dev_ship.h"
View
2 src/dev_system.c
@@ -5,7 +5,7 @@
/**
* @file dev_system.c
*
- * @brief Handles developement of star system stuff.
+ * @brief Handles development of star system stuff.
*/
#include "dev_system.h"
View
2 src/dialogue.c
@@ -5,7 +5,7 @@
/**
* @file dialogue.c
*
- * @brief Is a high level api around toolkit.c for easy window creation.
+ * @brief Is a high-level API around toolkit.c for easy window creation.
*
* Only one dialogue may be open at once or behaviour is unspecified.
*
View
6 src/economy.c
@@ -8,7 +8,7 @@
* @brief Handles economy stuff.
*
* Economy is handled with Nodal Analysis. Systems are modelled as nodes,
- * jump routes are resistances and production is modeled as node intensity.
+ * jump routes are resistances and production is modelled as node intensity.
* This is then solved with linear algebra after each time increment.
*/
@@ -112,7 +112,7 @@ void credits2str( char *str, credits_t credits, int decimals )
/**
- * @brief Gets a commoditiy by name.
+ * @brief Gets a commodity by name.
*
* @param name Name to match.
* @return Commodity matching name.
@@ -130,7 +130,7 @@ Commodity* commodity_get( const char* name )
/**
- * @brief Gets a commoditiy by name without warning.
+ * @brief Gets a commodity by name without warning.
*
* @param name Name to match.
* @return Commodity matching name.
View
6 src/equipment.c
@@ -742,7 +742,7 @@ static void equipment_renderOverlaySlots( double bx, double by, double bw, doubl
* @param bw Width of the widget.
* @param bh Height of the widget.
* @param x X position to render at.
- * @param y Y positon to render at.
+ * @param y Y position to render at.
* @param p Pilot to render.
*/
static void equipment_renderShip( double bx, double by,
@@ -845,7 +845,7 @@ static int equipment_mouseInColumn( double y, double h, int n, double my )
* @param mx Mouse X event position.
* @param my Mouse Y event position.
* @param y Y position of the column.
- * @param h Heighto f the column.
+ * @param h Height of the column.
* @param n Number of elements in the column.
* @param os Pointer to elements in the column.
* @param p Pilot to which the elements belong.
@@ -1067,7 +1067,7 @@ static int equipment_swapSlot( unsigned int wid, Pilot *p, PilotOutfitSlot *slot
/**
* @brief Regenerates the equipment window lists.
*
- * @param wid Window to regenrate lists.
+ * @param wid Window to regenerate lists.
* @param outfits Whether or not should regenerate outfits list.
* @param ships Whether or not to regenerate ships list.
*/
View
2 src/event.h
@@ -36,7 +36,7 @@ typedef enum EventTrigger_s {
/*
- * Loading/exitting.
+ * Loading/exiting.
*/
int events_load (void);
void events_exit (void);
View
2 src/explosion.c
@@ -92,7 +92,7 @@ void expl_explode( double x, double y, double vx, double vy,
* @param radius Radius of the explosion.
* @param dtype Damage type.
* @param damage Damage amount.
- * @param penetration Damage penetratior [0:1].
+ * @param penetration Damage penetration [0:1].
* @param parent Parent of the explosion, 0 is none.
* @param mode Defines the explosion behaviour.
*/
View
2 src/faction.c
@@ -943,7 +943,7 @@ int factions_load (void)
return -1;
}
- /* player faction is hardcoded */
+ /* player faction is hard-coded */
faction_stack = malloc( sizeof(Faction) );
memset(faction_stack, 0, sizeof(Faction) );
faction_stack[0].name = strdup("Player");
View
2 src/fleet.c
@@ -62,7 +62,7 @@ Fleet* fleet_get( const char* name )
/**
- * @brief Creates a pilot belonging to afleet.
+ * @brief Creates a pilot belonging to a fleet.
*
* @param flt Fleet to which pilot belongs to.
* @param plt Pilot to create.
View
2 src/font.c
@@ -12,7 +12,7 @@
* print it all, print to a max width, print centered or print a
* block of text.
*
- * There are hardcoded size limits. 256 characters for all routines
+ * There are hard-coded size limits. 256 characters for all routines
* except gl_printText which has a 1024 limit.
*
* @todo check if length is too long
View
4 src/gui.c
@@ -939,7 +939,7 @@ void gui_render( double dt )
/**
* @brief Initializes the radar.
*
- * @param circle Whether or not the radar is circlular.
+ * @param circle Whether or not the radar is circular.
*/
int gui_radarInit( int circle, int w, int h )
{
@@ -1996,7 +1996,7 @@ void gui_updateFaction (void)
/**
* @brief Calls trigger functions depending on who the pilot is.
*
- * @param The pilot to act base dupon.
+ * @param The pilot to act based upon.
*/
void gui_setGeneric (Pilot* pilot)
{
View
6 src/gui_osd.c
@@ -265,7 +265,7 @@ int osd_destroy( unsigned int osd )
*
* @param osd OSD to change active message.
* @param msg Message to make active in OSD.
- * @return 0 on succcess.
+ * @return 0 on success.
*/
int osd_active( unsigned int osd, int msg )
{
@@ -425,7 +425,7 @@ static void osd_calcDimensions (void)
* @brief Gets the title of an OSD.
*
* @param osd OSD to get title of.
- * @return Title of the OSd.
+ * @return Title of the OSD.
*/
char *osd_getTitle( unsigned int osd )
{
@@ -443,7 +443,7 @@ char *osd_getTitle( unsigned int osd )
* @brief Gets the items of an OSD.
*
* @param osd OSD to get items of.
- * @param[out] nitems Numeb of OSD items.
+ * @param[out] nitems Number of OSD items.
*/
char **osd_getItems( unsigned int osd, int *nitems )
{
View
2 src/hook.c
@@ -592,7 +592,7 @@ unsigned int hook_addTimerMisn( unsigned int parent, const char *func, double ms
*
* @param parent Hook event parent.
* @param func Function to run when hook is triggered.
- * @param ms Miliseconds to wait.
+ * @param ms Milliseconds to wait.
* @return The new hook identifier.
*/
unsigned int hook_addTimerEvt( unsigned int parent, const char *func, double ms )
View
4 src/info.c
@@ -454,7 +454,7 @@ static void weapons_rename( unsigned int wid, char *str )
/**
- * @brief Toggles autoweap for the sihp.
+ * @brief Toggles autoweap for the ship.
*/
static void weapons_autoweap( unsigned int wid, char *str )
{
@@ -878,7 +878,7 @@ static void mission_menu_genList( unsigned int wid, int first )
}
/**
* @brief Updates the mission menu mission information based on what's selected.
- * @param str Unusued.
+ * @param str Unused.
*/
static void mission_menu_update( unsigned int wid, char* str )
{
View
2 src/land.c
@@ -526,7 +526,7 @@ static void bar_open( unsigned int wid )
}
/**
- * @brief Generates the misison list for the bar.
+ * @brief Generates the mission list for the bar.
*
* @param wid Window to create mission list for.
*/
View
2 src/land_shipyard.h
@@ -16,7 +16,7 @@ void shipyard_update( unsigned int wid, char* str );
/*
- * Helpe functions.
+ * Helper functions.
*/
int shipyard_canBuy( char *shipname );
int shipyard_canTrade( char *shipname );
View
2 src/log.c
@@ -5,7 +5,7 @@
/**
* @file log.c
*
- * @brief Home of loprintf.
+ * @brief Home of logprintf.
*/
#include "log.h"
View
2 src/map.c
@@ -1534,7 +1534,7 @@ StarSystem** map_getJumpPath( int* njumps, const char* sysstart,
/**
- * @brief Marks maps around a radius of currenty system as known.
+ * @brief Marks maps around a radius of currently system as known.
*
* @param targ_sys System at center of the "known" circle.
* @param r Radius (in jumps) to mark as known.
View
2 src/map_find.c
@@ -160,7 +160,7 @@ static void map_find_check_update( unsigned int wid, char* str )
/**
- * @brief Clsoses the find window.
+ * @brief Closes the find window.
*/
static void map_findClose( unsigned int wid, char* str )
{
View
4 src/map_overlay.c
@@ -21,7 +21,7 @@
/**
- * @brief Ano verlay map marker.
+ * @brief An overlay map marker.
*/
typedef struct ovr_marker_s {
unsigned int id; /**< ID of the marker. */
@@ -355,7 +355,7 @@ void ovr_mrkFree (void)
/**
- * @brief Clears the curent markers.
+ * @brief Clears the current markers.
*/
void ovr_mrkClear (void)
{
View
2 src/mission.c
@@ -136,7 +136,7 @@ MissionData* mission_get( int id )
/**
- * @brief Gets mission data frm name.
+ * @brief Gets mission data from a name.
*/
MissionData* mission_getFromName( const char* name )
{
View
2 src/music.c
@@ -568,7 +568,7 @@ static int music_luaInit (void)
/**
- * @brief Quits the music Lua contrtol system.
+ * @brief Quits the music Lua control system.
*/
static void music_luaQuit (void)
{
View
4 src/naev.c
@@ -981,7 +981,7 @@ int naev_versionParse( int version[3], char *buf, int nbuf )
/**
- * @brief Comparse the version against the current naev version.
+ * @brief Compares the version against the current naev version.
*
* @return positive if version is newer or negative if version is older.
*/
@@ -1205,7 +1205,7 @@ static void debug_sigInit (void)
/**
- * @brief Closes the SignalHandler for linux.
+ * @brief Closes the SignalHandler for Linux.
*/
static void debug_sigClose (void)
{
View
2 src/nebula.c
@@ -800,7 +800,7 @@ static int saveNebula( float *map, const uint32_t w, const uint32_t h, const cha
/**
- * @brief Loads the nebuale from file.
+ * @brief Loads the nebulae from file.
*
* @param file Path of the nebula to load. Relative to base directory.
* @return A SDL surface with the nebula.
View
2 src/news.c
@@ -69,7 +69,7 @@ static void news_mouse( unsigned int wid, SDL_Event *event, double mx, double my
* @brief Renders a news widget.
*
* @param bx Base X position to render at.
- * @param by Base Y positoin to render at.
+ * @param by Base Y position to render at.
* @param w Width of the widget.
* @param h Height of the widget.
*/
View
10 src/nfile.c
@@ -7,7 +7,7 @@
*
* @brief Handles read/write abstractions to the users directory.
*
- * @todo add support for windows and mac os.
+ * @todo Add support for Windows and Mac OS X.
*/
@@ -39,11 +39,11 @@
-static char naev_base[PATH_MAX] = "\0"; /**< Stores naev's base path. */
+static char naev_base[PATH_MAX] = "\0"; /**< Stores Naev's base path. */
/**
- * @brief Gets naev's base path (for saves and such).
+ * @brief Gets Naev's base path (for saves and such).
*
- * @return The base path to naev.
+ * @return The base path to Naev.
*/
char* nfile_basePath (void)
{
@@ -177,7 +177,7 @@ int nfile_dirExists( const char* path, ... )
/**
* @brief Checks to see if a file exists.
*
- * @param path printf formatted string pointing to the file to check for existance.
+ * @param path printf formatted string pointing to the file to check for existence.
* @return 1 if file exists, 0 if it doesn't or -1 on error.
*/
int nfile_fileExists( const char* path, ... )
View
4 src/nlua_gui.c
@@ -93,12 +93,12 @@ int nlua_loadGUI( lua_State *L, int readonly )
* @brief Sets the gui viewport.
*
* Basically this limits what the rest of the game considers as the screen.
- * Careful when using this or you can make the game look ugly and uplayable.
+ * Careful when using this or you can make the game look ugly and unplayable.
* So use common sense and try to avoid windows smaller than 800x600 if
* possible.
*
* @usage gui.viewport( 0, 0, screen_w, screen_h ) -- Resets viewport.
- * @usage gui.viewport( 0, 20, screen_w, screen_h-20 ) -- Gives 20 pixels for a bottombar.
+ * @usage gui.viewport( 0, 20, screen_w, screen_h-20 ) -- Gives 20 pixels for a bottom bar.
*
* @luaparam x X position to start clipping (bottom left is 0.)
* @luaparam y Y position to start clipping (bottom left is 0.)
View
4 src/nlua_hook.c
@@ -197,7 +197,7 @@ void hookL_unsetarg( lua_State *L, unsigned int hook )
* @brief Gets a Lua argument for a hook.
*
* @param L Lua state to put argument in.
- * @param hook Hook te get argument of.
+ * @param hook Hook to get argument of.
* @return 0 on success.
*/
int hookL_getarg( lua_State *L, unsigned int hook )
@@ -560,7 +560,7 @@ static int hook_safe( lua_State *L )
/**
* @brief Hooks the function to a specific pilot.
*
- * You can hook to different actions. Curently hook system only supports:<br />
+ * You can hook to different actions. Currently hook system only supports:<br />
* <ul>
* <li> "death" : triggered when pilot dies (before marked as dead). <br />
* <li> "exploded" : triggered when pilot has died and the final explosion has begun. <br />
View
8 src/nlua_pilot.c
@@ -893,7 +893,7 @@ static int pilotL_name( lua_State *L )
* @usage id = p:id()
*
* @luaparam p Pilot to get the ID of.
- * @luareturn The ID of the curent pilot.
+ * @luareturn The ID of the current pilot.
* @luafunc id( p )
*/
static int pilotL_id( lua_State *L )
@@ -1774,7 +1774,7 @@ static int pilotL_setVisible( lua_State *L )
/**
* @brief Makes pilot stand out on radar and the likes.
*
- * This makes the pilot stand out in the map overlay and radar to increase noticeability.
+ * This makes the pilot stand out in the map overlay and radar to increase noticability.
*
* @usage p:setHilight( true )
*
@@ -2315,7 +2315,7 @@ static int pilotL_setNodisable( lua_State *L )
* @usage armour, shield, dis = p:health()
*
* @luaparam p Pilot to get health of.
- * @luareturn The armour and shield of the pilot in % [0:100], followed by a boolean indicating if piloti s disabled.
+ * @luareturn The armour and shield of the pilot in % [0:100], followed by a boolean indicating if pilot is disabled.
* @luafunc health( p )
*/
static int pilotL_getHealth( lua_State *L )
@@ -2577,7 +2577,7 @@ static int pilotL_cargoRm( lua_State *L )
* The list has the following members:<br />
* <ul>
* <li><b>name:</b> name of the cargo.
- * <li><b>q:</b> quantity of the targo.
+ * <li><b>q:</b> quantity of the cargo.
* <li><b>m:</b> true if cargo is for a mission.
* </ul>
*
View
2 src/nlua_planet.c
@@ -590,7 +590,7 @@ static int planetL_canland( lua_State *L )
*
* @usage p:landOverride( true ) -- Planet can land on p now.
* @luaparam p Planet to forcibly allow the player to land on.
- * @luaparam b Whether or not the player should be allowed to land, true enables, false disableds override.
+ * @luaparam b Whether or not the player should be allowed to land, true enables, false disables override.
* @luafunc landOverride( p, b )
*/
static int planetL_landOverride( lua_State *L )
View
4 src/nlua_player.c
@@ -952,8 +952,8 @@ static int playerL_evtDone( lua_State *L )
*
* Does not change the position nor velocity of the player.p, which will probably be wrong in the new system.
*
- * @usage player.teleport( system.get("Arcanis") ) -- Teleports the player to arcanis.
- * @usage player.teleport( "Arcanis" ) -- Teleports the player to arcanis.
+ * @usage player.teleport( system.get("Arcanis") ) -- Teleports the player to Arcanis.
+ * @usage player.teleport( "Arcanis" ) -- Teleports the player to Arcanis.
*
* @luaparam sys System or name of a system to teleport the player to.
* @luafunc teleport( sys )
View
2 src/nlua_ship.c
@@ -401,7 +401,7 @@ static int shipL_gfxTarget( lua_State *L )
/**
* @brief Gets the ship's graphics.
*
- * Will not work without access to the Tex module. These are nearly always a spritesheet.
+ * Will not work without access to the Tex module. These are nearly always a sprite sheet.
*
* @usage gfx = s:gfx()
*
View
2 src/nstd.h
@@ -46,7 +46,7 @@
*/
#define nstd_tolower(k) (nstd_checkascii(k) ? (SDLKey)tolower(k) : k)
/**
- * @brief Cnoverts a key to uppercase if applicable.
+ * @brief Converts a key to uppercase if applicable.
*/
#define nstd_toupper(k) (nstd_checkascii(k) ? (SDLKey)toupper(k) : k)
View
4 src/nxml_lua.c
@@ -255,7 +255,7 @@ int nxml_persistLua( lua_State *L, xmlTextWriterPtr writer )
/**
* @brief Unpersists Lua data.
*
- * @param L State to unperisist data into.
+ * @param L State to unpersist data into.
* @param parent Node containing all the Lua persisted data.
* @return 0 on success.
*/
@@ -355,7 +355,7 @@ static int nxml_unpersistDataNode( lua_State *L, xmlNodePtr parent )
/**
* @brief Unpersists Lua data.
*
- * @param L State to unperisist data into.
+ * @param L State to unpersist data into.
* @param parent Node containing all the Lua persisted data.
* @return 0 on success.
*/
View
4 src/opengl.c
@@ -16,7 +16,7 @@
* Relative:
* * Everything is drawn relative to the player, if it doesn't fit on screen
* it is clipped.
- * * Origin (0., 0.) wouldbe ontop of the player.
+ * * Origin (0., 0.) would be ontop of the player.
*
* Absolute:
* * Everything is drawn in "screen coordinates".
@@ -543,7 +543,7 @@ static int gl_defState (void)
/**
- * @brief Checks ot see if window needs to handle scaling.
+ * @brief Checks to see if window needs to handle scaling.
*
* @return 0 on success.
*/
View
8 src/opengl_render.c
@@ -12,7 +12,7 @@
* Relative:
* * Everything is drawn relative to the player, if it doesn't fit on screen
* it is clipped.
- * * Origin (0., 0.) wouldbe ontop of the player.
+ * * Origin (0., 0.) would be ontop of the player.
*
* Absolute:
* * Everything is drawn in "screen coordinates".
@@ -338,7 +338,7 @@ void gl_blitTexture( const glTexture* texture,
*
* @param ta Texture A to blit.
* @param tb Texture B to blit.
- * @param intere Amount of interpolation to do.
+ * @param inter Amount of interpolation to do.
* @param x X position of the texture on the screen.
* @param y Y position of the texture on the screen.
* @param tx X position within the texture.
@@ -506,7 +506,7 @@ static void gl_blitTextureInterpolate( const glTexture* ta,
/**
- * @brief Convertes ingame coordinates to screen coordinates.
+ * @brief Converts ingame coordinates to screen coordinates.
*
* @param[out] nx New screen X coord.
* @param[out] ny New screen Y coord.
@@ -866,7 +866,7 @@ static void gl_drawCircleEmpty( const double cx, const double cy,
* @param cy Y position of the center in screen coordinates.
* @param r Radius of the circle.
* @param c Colour to use.
- * @param filled yWhether or not it should be filled.
+ * @param filled Whether or not it should be filled.
*/
void gl_drawCircle( const double cx, const double cy,
const double r, const glColour *c, int filled )
View
2 src/opengl_tex.h
@@ -40,7 +40,7 @@
#define OPENGL_TEX_MIPMAPS (1<<1) /**< Creates mipmaps. */
/**
- * @brief Abstraction for rendering spriteshets.
+ * @brief Abstraction for rendering sprite sheets.
*
* The basic unit all the graphic rendering works with.
*/
View
8 src/outfit.c
@@ -233,7 +233,7 @@ int outfit_compareTech( const void *outfit1, const void *outfit2 )
* @param[out] knockback Knocback modifier.
* @param[in] stats Stats to calculate with.
* @param[in] dtype Damage type.
- * @param[in] dmg Amoung of damage.
+ * @param[in] dmg Amount of damage.
*/
void outfit_calcDamage( double *dshield, double *darmour, double *knockback,
const ShipStats *stats, DamageType dtype, double dmg )
@@ -361,7 +361,7 @@ glColour *outfit_slotSizeColour( const OutfitSlot* os )
/**
* @brief Gets the outfit slot size from a human readable string.
*
- * @param s String represinting an outfit slot size.
+ * @param s String representing an outfit slot size.
* @return Outfit slot size matching string.
*/
OutfitSlotSize outfit_toSlotSize( const char *s )
@@ -635,7 +635,7 @@ Outfit* outfit_ammo( const Outfit* o )
return NULL;
}
/**
- * @brief Gets the ammount an outfit can hold.
+ * @brief Gets the amount an outfit can hold.
* @param o Outfit to get information from.
*/
int outfit_amount( const Outfit* o )
@@ -947,7 +947,7 @@ static OutfitType outfit_strToOutfitType( char *buf )
* @endcode
*
* @param[out] dtype Stores the damage type here.
- * @param[out] dmg Storse the damage here.
+ * @param[out] dmg Stores the damage here.
* @param[in] node Node to parse damage from.
* @return 0 on success.
*/
View
4 src/pack.c
@@ -812,7 +812,7 @@ static void* pack_readfilePack( Packfile_t *file,
/**
* @brief Reads an entire file into memory.
*
- * @param packfile Name of the packfile to read frome.
+ * @param packfile Name of the packfile to read from.
* @param filename Name of the packed file to read.
* @param filesize Is set to the size of the file.
* @return A pointer to the data in the file or NULL if an error occurred.
@@ -842,7 +842,7 @@ void* pack_readfile( const char* packfile, const char* filename, uint32_t *files
*
* @brief Gets what files are in the packfile.
*
- * Each name must be freed individually afterwarsd and the array of names too.
+ * Each name must be freed individually afterwards and the array of names too.
*
* @param packfile Packfile to query it's internal files.
* @param nfiles Stores the amount of files in packfile.
View
4 src/physics.c
@@ -250,7 +250,7 @@ void vect_uv_decomp( Vector2d* u, Vector2d* v, Vector2d* reference_vector )
* S O L I D
*/
/**
- * @brief Updates the solid's position using an euler integration.
+ * @brief Updates the solid's position using an Euler integration.
*
* Simple method
*
@@ -260,7 +260,7 @@ void vect_uv_decomp( Vector2d* u, Vector2d* v, Vector2d* reference_vector )
* d x(t) / d t = a*t + v, v = constant (initial velocity)
* x(t) = a/2*t + v*t + p, p = constant (initial position)
*
- * since d t isn't actually diferential this gives us ERROR!
+ * since dt isn't actually differential this gives us ERROR!
* so watch out with big values for dt
*
*/
View
12 src/pilot.c
@@ -68,7 +68,7 @@ static double pilot_commFade = 5.; /**< Time for text above pilot to fade ou
/*
- * prototyes
+ * prototypes
*/
/* update. */
static void pilot_hyperspace( Pilot* pilot, double dt );
@@ -327,7 +327,7 @@ unsigned int pilot_getNearestEnemy_size( const Pilot* p, int target_mass_LB, int
*
* @param p Pilot to get the nearest enemy of.
* @param mass_factor parameter for target mass (0-1, 0.5 = current mass)
- * @param health_factor parameter for target shields/armor (0-1, 0.5 = current health)
+ * @param health_factor parameter for target shields/armour (0-1, 0.5 = current health)
* @param dps_factor parameter for target dps (0-1, 0.5 = current dps)
* @param range_factor weighting for range (typically >> 1)
* @return ID of his nearest enemy.
@@ -506,7 +506,7 @@ double pilot_getNearestAng( const Pilot *p, unsigned int *tp, double ang, int di
* @brief Pulls a pilot out of the pilot_stack based on ID.
*
* It's a binary search ( O(logn) ) therefore it's pretty fast and can be
- * abused all the time. Maximum iterations is 32 on a platfom with 32 bit
+ * abused all the time. Maximum iterations is 32 on a platform with 32 bit
* unsigned ints.
*
* @param id ID of the pilot to get.
@@ -1816,7 +1816,7 @@ credits_t pilot_modCredits( Pilot *p, credits_t amount )
/**
* @brief Initialize pilot.
*
- * @param pilot Pilot to initialise.
+ * @param pilot Pilot to initialize.
* @param ship Ship pilot will be flying.
* @param name Pilot's name, if NULL ship's name will be used.
* @param faction Faction of the pilot.
@@ -2474,9 +2474,9 @@ double pilot_reldps( const Pilot* cur_pilot, const Pilot* p )
}
/**
- * @brief Gets the relative hp(combined shields and armor) between the current pilot and the specified target
+ * @brief Gets the relative hp(combined shields and armour) between the current pilot and the specified target
*
- * @param p the pilot whose shields/armor we will compare
+ * @param p the pilot whose shields/armour we will compare
* @return A number from 0 to 1 mapping the relative HPs
*/
double pilot_relhp( const Pilot* cur_pilot, const Pilot* p )
View
2 src/pilot_ew.c
@@ -25,7 +25,7 @@ static double sensor_curRange = 0.; /**< Current base sensor range, used to c
/**
- * @brief Updates the pilot's sattic electronic warfare properties.
+ * @brief Updates the pilot's static electronic warfare properties.
*
* @param p Pilot to update.
*/
View
6 src/pilot_heat.c
@@ -22,7 +22,7 @@
/**
* @brief Calculates the heat parameters for a pilot.
*
- * We treat the ship as more or less ac onstant slab of steel.
+ * We treat the ship as more or less a constant slab of steel.
*
* @param p Pilot to update heat properties of.
*/
@@ -145,7 +145,7 @@ void pilot_heatAddSlot( Pilot *p, PilotOutfitSlot *o )
* @param p Pilot to update.
* @param o Outfit slot to update.
* @param dt Delta tick.
- * @return The energy transfered.
+ * @return The energy transferred.
*/
double pilot_heatUpdateSlot( Pilot *p, PilotOutfitSlot *o, double dt )
{
@@ -174,7 +174,7 @@ double pilot_heatUpdateSlot( Pilot *p, PilotOutfitSlot *o, double dt )
*
* q = p + sigma * epsilon * (T^4 - To^4)
*
- * sigma being the stefan-boltzmann constant [5] = 5.67×10−8 W/(m^2 K^4)
+ * sigma being the Stefan-Boltzmann constant [5] = 5.67×10−8 W/(m^2 K^4)
* epsilon being a parameter between 0 and 1 (1 being black body)
* T being body temperature
* To being "space temperature"
View
2 src/pilot_heat.h
@@ -31,7 +31,7 @@
/*
* Properties of steel.
*
- * Yes, there are mayn different types of steels, these are sort of "average values" for carbon steel.
+ * Yes, there are many different types of steels, these are sort of "average values" for carbon steel.
*/
#define STEEL_HEAT_CONDUCTIVITY (54.) /**< Thermal conductivity of steel (@ 25C). [W/(m*K)] */
#define STEEL_HEAT_CAPACITY (0.49) /**< Thermal capacity of steel. [J/(kg*K)] */
View
12 src/player.c
@@ -431,7 +431,7 @@ static int player_newMake (void)
* @brief Creates a new ship for player.
*
* @param ship New ship to get.
- * @param def_name Default name to give it if canceled.
+ * @param def_name Default name to give it if cancelled.
* @param trade Whether or not to trade player's current ship with the new ship.
* @param noname Whether or not to let the player name it.
* @return Newly created pilot on success or NULL if dialogue was cancelled.
@@ -1201,7 +1201,7 @@ void player_update( Pilot *pplayer, const double dt )
/**
- * @brief Does a pleyr specific update.
+ * @brief Does a player specific update.
*
* @param pplayer Player to update.
* @param dt Current deltatick.
@@ -1251,12 +1251,10 @@ void player_updateSpecific( Pilot *pplayer, const double dt )
/*
- *
* For use in keybindings
- *
*/
/**
- * @brief Actiavtes a player's weapon set.
+ * @brief Activates a player's weapon set.
*/
void player_weapSetPress( int id, int type )
{
@@ -1456,7 +1454,7 @@ void player_land (void)
/**
* @brief Sets the no land message.
*
- * @brief str Message to set when the playre is not allowed to land temporarily.
+ * @brief str Message to set when the player is not allowed to land temporarily.
*/
void player_nolandMsg( const char *str )
{
@@ -1728,7 +1726,7 @@ void player_afterburnOver (int type)
/**
* @brief Start accelerating.
*
- * @param acc How much thrust should beb applied of maximum (0 - 1).
+ * @param acc How much thrust should be applied of maximum (0 - 1).
*/
void player_accel( double acc )
{
View
2 src/rng.c
@@ -1,5 +1,5 @@
/*
- * See Licensing and Copmt_yright notice in naev.h
+ * See Licensing and Copyright notice in naev.h
*/
/**
View
2 src/sound.c
@@ -475,7 +475,7 @@ int sound_updatePos( int voice, double px, double py, double vx, double vy )
/**
- * @brief Updates the sonuds removing obsolete ones and such.
+ * @brief Updates the sounds removing obsolete ones and such.
*
* @return 0 on success.
*/
View
4 src/sound_openal.c
@@ -51,7 +51,7 @@
*
* We use multiple effects, namely:
*
- * - Air absoprtion factor
+ * - Air absorption factor
* - Reverb
*/
@@ -71,7 +71,7 @@ SDL_mutex *sound_lock = NULL; /**< Global sound lock, always lock this before
/*
- * Global device and contex.
+ * Global device and context.
*/
static ALCcontext *al_context = NULL; /**< OpenAL context. */
static ALCdevice *al_device = NULL; /**< OpenAL device. */
View
2 src/sound_sdlmix.c
@@ -392,7 +392,7 @@ double sound_mix_getVolume (void)
/**
* @brief Loads a sound into the sound_list.
*
- * @param filename Name fo the file to load.
+ * @param filename Name of the file to load.
* @return The SDL_Mixer of the loaded chunk.
*
* @sa sound_makeList
View
4 src/spfx.c
@@ -50,7 +50,7 @@
/*
- * special hardcoded special effects
+ * special hard-coded special effects
*/
/* shake aka rumble */
static int shake_set = 0; /**< Is shake set? */
@@ -215,7 +215,7 @@ int spfx_get( char* name )
*
* @return 0 on success.
*
- * @todo Make spfx not hardcoded.
+ * @todo Make spfx not hard-coded.
*/
int spfx_load (void)
{
View
2 src/tech.c
@@ -328,7 +328,7 @@ static int tech_parseNodeData( tech_group_t *tech, xmlNodePtr parent )
continue;
}
- /* Try to find hardcoded type. */
+ /* Try to find hard-coded type. */
buf = xml_nodeProp( node, "type" );
if (buf == NULL) {
ret = 1;
View
2 src/toolkit.c
@@ -488,7 +488,7 @@ unsigned int window_getParent( unsigned int wid )
* This function is called when the window is closed.
*
* @param wid Window to set close function of.
- * @param Function to tirgger when window is closed, parameter is window id
+ * @param Function to trigger when window is closed, parameter is window id
* and name.
*/
void window_onClose( unsigned int wid, void (*fptr)(unsigned int,char*) )
View
2 src/weapon.c
@@ -1476,7 +1476,7 @@ void weapon_add( const Outfit* outfit, const double T, const double dir,
/**
- * @brief Starts a beam weaapon.
+ * @brief Starts a beam weapon.
*
* @param outfit Outfit which spawns the weapon.
* @param dir Direction of the shooter.

0 comments on commit d1bdc59

Please sign in to comment.
Something went wrong with that request. Please try again.