[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Stratagus-CVS] stratagus/src clone/ccl.c clone/iolib.c clone/u...
|
From: |
Russell Smith |
|
Subject: |
[Stratagus-CVS] stratagus/src clone/ccl.c clone/iolib.c clone/u... |
|
Date: |
Thu, 18 Sep 2003 07:59:22 -0400 |
CVSROOT: /cvsroot/stratagus
Module name: stratagus
Branch:
Changes by: Russell Smith <address@hidden> 03/09/18 07:59:21
Modified files:
src/clone : ccl.c iolib.c unit.c unit_draw.c unit_find.c
src/include : unittype.h
src/include/etlib: dllist.h
src/map : map_fog.c
src/network : commands.c lowlevel.c netconnect.c network.c
src/pathfinder : pathfinder.c
src/unit : ccl_unit.c
Log message:
Fixes for documentation and doxygen warnings
Patches:
Index: stratagus/src/clone/ccl.c
diff -u stratagus/src/clone/ccl.c:1.108 stratagus/src/clone/ccl.c:1.109
--- stratagus/src/clone/ccl.c:1.108 Sun Aug 17 11:57:06 2003
+++ stratagus/src/clone/ccl.c Thu Sep 18 07:59:20 2003
@@ -26,7 +26,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: ccl.c,v 1.108 2003/08/17 15:57:06 n0body Exp $
+// $Id: ccl.c,v 1.109 2003/09/18 11:59:20 mr-russ Exp $
//@{
@@ -264,9 +264,9 @@
/**
** Return of game name.
**
-** @param name SCM name. (nil reports only)
+** @param gamename SCM name. (nil reports only)
**
-** @return Old game name.
+** @return Old game name.
*/
local SCM CclSetGameName(SCM gamename)
{
@@ -1023,7 +1023,7 @@
}
fprintf(fd,";;; -----------------------------------------\n");
- fprintf(fd,";;; $Id: ccl.c,v 1.108 2003/08/17 15:57:06 n0body Exp $\n");
+ fprintf(fd,";;; $Id: ccl.c,v 1.109 2003/09/18 11:59:20 mr-russ Exp $\n");
fprintf(fd,"(set-video-resolution! %d %d)\n", VideoWidth, VideoHeight);
@@ -1047,7 +1047,7 @@
}
fprintf(fd,";;; -----------------------------------------\n");
- fprintf(fd,";;; $Id: ccl.c,v 1.108 2003/08/17 15:57:06 n0body Exp $\n");
+ fprintf(fd,";;; $Id: ccl.c,v 1.109 2003/09/18 11:59:20 mr-russ Exp $\n");
// Global options
if( OriginalFogOfWar ) {
@@ -1157,7 +1157,7 @@
extern SCM oblistvar;
CLprintf(file,"\n;;; -----------------------------------------\n");
- CLprintf(file,";;; MODULE: CCL $Id: ccl.c,v 1.108 2003/08/17 15:57:06
n0body Exp $\n\n");
+ CLprintf(file,";;; MODULE: CCL $Id: ccl.c,v 1.109 2003/09/18 11:59:20
mr-russ Exp $\n\n");
for(list = oblistvar; gh_list_p(list); list = gh_cdr(list) ) {
SCM sym;
Index: stratagus/src/clone/iolib.c
diff -u stratagus/src/clone/iolib.c:1.51 stratagus/src/clone/iolib.c:1.52
--- stratagus/src/clone/iolib.c:1.51 Sun Aug 17 11:57:06 2003
+++ stratagus/src/clone/iolib.c Thu Sep 18 07:59:21 2003
@@ -26,7 +26,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: iolib.c,v 1.51 2003/08/17 15:57:06 n0body Exp $
+// $Id: iolib.c,v 1.52 2003/09/18 11:59:21 mr-russ Exp $
//@{
@@ -148,7 +148,10 @@
/**
** CLopen Library file open
**
-** @param fn File name.
+** @param fn File name.
+** @param openflags Open read, or write and compression options
+**
+** @return File Pointer
*/
global CLFile *CLopen(const char *fn,long openflags)
{
Index: stratagus/src/clone/unit.c
diff -u stratagus/src/clone/unit.c:1.295 stratagus/src/clone/unit.c:1.296
--- stratagus/src/clone/unit.c:1.295 Sun Sep 14 00:45:52 2003
+++ stratagus/src/clone/unit.c Thu Sep 18 07:59:21 2003
@@ -26,7 +26,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: unit.c,v 1.295 2003/09/14 04:45:52 mr-russ Exp $
+// $Id: unit.c,v 1.296 2003/09/18 11:59:21 mr-russ Exp $
//@{
@@ -2473,7 +2473,7 @@
** @param px OUT: Map X position of tile.
** @param py OUT: Map Y position of tile.
**
- ** @notes Movement mask can be 0xFFFFFFFF to have no effect
+ ** @note Movement mask can be 0xFFFFFFFF to have no effect
** Range is not circular, but square.
** Player is ignored if nil(search the entire map)
** Use rvresult if you search for a til;e that doesn't
@@ -2584,11 +2584,11 @@
**
** @param unit The unit that wants to find a resource.
** @param x Closest to x
- ** @param x Closest to y
+ ** @param y Closest to y
** @param range Maximum distance to the resource.
** @param resource The resource id.
**
- ** @notes This will return an usable resource building that
+ ** @note This will return an usable resource building that
** belongs to "player" or is neutral.
**
** @return NoUnitP or resource unit
@@ -2729,12 +2729,13 @@
**
** @param unit The unit that wants to find a resource.
** @param x Closest to x
- ** @param x Closest to y
+ ** @param y Closest to y
** @param range Maximum distance to the deposit.
+ ** @param resource Resource to find deposit from.
**
- ** @notes This will return a reachable allied depot.
+ ** @note This will return a reachable allied depot.
**
- ** @return NoUnitP or oil deposit unit
+ ** @return NoUnitP or deposit unit
*/
global Unit* FindDeposit(const Unit* unit,int x,int y,int range,int resource)
{
@@ -3964,7 +3965,7 @@
int InRun, RunStart;
CLprintf(file,"\n;;; -----------------------------------------\n");
- CLprintf(file,";;; MODULE: units $Id: unit.c,v 1.295 2003/09/14 04:45:52
mr-russ Exp $\n\n");
+ CLprintf(file,";;; MODULE: units $Id: unit.c,v 1.296 2003/09/18 11:59:21
mr-russ Exp $\n\n");
//
// Local variables
Index: stratagus/src/clone/unit_draw.c
diff -u stratagus/src/clone/unit_draw.c:1.159
stratagus/src/clone/unit_draw.c:1.160
--- stratagus/src/clone/unit_draw.c:1.159 Thu Sep 11 18:07:53 2003
+++ stratagus/src/clone/unit_draw.c Thu Sep 18 07:59:21 2003
@@ -26,7 +26,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: unit_draw.c,v 1.159 2003/09/11 22:07:53 n0body Exp $
+// $Id: unit_draw.c,v 1.160 2003/09/18 11:59:21 mr-russ Exp $
//@{
@@ -577,7 +577,7 @@
global void SaveDecorations(CLFile* file)
{
CLprintf(file,"\n;;; -----------------------------------------\n");
- CLprintf(file,";;; MODULE: decorations $Id: unit_draw.c,v 1.159 2003/09/11
22:07:53 n0body Exp $\n\n");
+ CLprintf(file,";;; MODULE: decorations $Id: unit_draw.c,v 1.160 2003/09/18
11:59:21 mr-russ Exp $\n\n");
CLprintf(file,"(mana-sprite \"%s\" %d %d %d %d)\n",
ManaSprite.File,ManaSprite.HotX,ManaSprite.HotY,
@@ -1345,10 +1345,10 @@
/**
** Get the location of an unit's order.
**
-** @param order Pointer to unit.
+** @param unit Pointer to unit.
** @param order Pointer to order.
** @param x Resulting screen X cordinate.
-** @param x Resulting screen Y cordinate.
+** @param y Resulting screen Y cordinate.
*/
local void GetOrderPosition(const Unit* unit,const Order* order,int* x,int* y)
{
Index: stratagus/src/clone/unit_find.c
diff -u stratagus/src/clone/unit_find.c:1.56
stratagus/src/clone/unit_find.c:1.57
--- stratagus/src/clone/unit_find.c:1.56 Fri Sep 5 14:10:55 2003
+++ stratagus/src/clone/unit_find.c Thu Sep 18 07:59:21 2003
@@ -26,7 +26,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: unit_find.c,v 1.56 2003/09/05 18:10:55 n0body Exp $
+// $Id: unit_find.c,v 1.57 2003/09/18 11:59:21 mr-russ Exp $
//@{
@@ -382,6 +382,7 @@
**
** @param tx X position on map, tile-based.
** @param ty Y position on map, tile-based.
+** @param type Unit Type to Find
**
** @return Returns the unit if found, or NoUnitP.
*/
Index: stratagus/src/include/etlib/dllist.h
diff -u stratagus/src/include/etlib/dllist.h:1.6
stratagus/src/include/etlib/dllist.h:1.7
--- stratagus/src/include/etlib/dllist.h:1.6 Mon Jun 10 17:59:40 2002
+++ stratagus/src/include/etlib/dllist.h Thu Sep 18 07:59:21 2003
@@ -1,12 +1,15 @@
-#ifndef ETLIB_DLLIST_H
-#define ETLIB_DLLIST_H
/**
** @author Copyright by Edgar Toernig.
** @name dllist.h - Double linked lists.
**
-* $Id: dllist.h,v 1.6 2002/06/10 21:59:40 johns Exp $
+* $Id: dllist.h,v 1.7 2003/09/18 11:59:21 mr-russ Exp $
*/
+#ifndef ETLIB_DLLIST_H
+#define ETLIB_DLLIST_H
+
+//@{
+
struct dl_node
{
struct dl_node *next;
@@ -60,5 +63,7 @@
#define dl_insert_last(h, n) (dl_insert_after((h)->last, (n)))
#define dl_remove_first(h) dl_remove((h)->first) // mustn't be empty!
#define dl_remove_last(h) dl_remove((h)->last) // mustn't be empty!
+
+//@}
#endif /* ETLIB_DLLIST_H */
Index: stratagus/src/include/unittype.h
diff -u stratagus/src/include/unittype.h:1.106
stratagus/src/include/unittype.h:1.107
--- stratagus/src/include/unittype.h:1.106 Fri Sep 12 13:44:36 2003
+++ stratagus/src/include/unittype.h Thu Sep 18 07:59:21 2003
@@ -26,7 +26,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: unittype.h,v 1.106 2003/09/12 17:44:36 n0body Exp $
+// $Id: unittype.h,v 1.107 2003/09/18 11:59:21 mr-russ Exp $
#ifndef __UNITTYPE_H__
#define __UNITTYPE_H__
@@ -506,6 +506,8 @@
** over UnitType::Sprite. Used with OpenGL only.
**
**
+*/
+/**
**
** @struct _resource_info_ unittype.h
**
Index: stratagus/src/map/map_fog.c
diff -u stratagus/src/map/map_fog.c:1.104 stratagus/src/map/map_fog.c:1.105
--- stratagus/src/map/map_fog.c:1.104 Sun Sep 14 19:25:41 2003
+++ stratagus/src/map/map_fog.c Thu Sep 18 07:59:21 2003
@@ -27,7 +27,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: map_fog.c,v 1.104 2003/09/14 23:25:41 mr-russ Exp $
+// $Id: map_fog.c,v 1.105 2003/09/18 11:59:21 mr-russ Exp $
//@{
@@ -340,7 +340,8 @@
** @param player player to mark the sight for (not unit owner)
** @param x x location to mark
** @param y y location to mark
-**
+** @param w width to mark, in square
+** @param h height to mark, in square
** @param range Radius to mark.
** @param marker Function to mark or unmark sight
*/
Index: stratagus/src/network/commands.c
diff -u stratagus/src/network/commands.c:1.65
stratagus/src/network/commands.c:1.66
--- stratagus/src/network/commands.c:1.65 Fri Sep 5 14:10:56 2003
+++ stratagus/src/network/commands.c Thu Sep 18 07:59:21 2003
@@ -26,7 +26,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: commands.c,v 1.65 2003/09/05 18:10:56 n0body Exp $
+// $Id: commands.c,v 1.66 2003/09/18 11:59:21 mr-russ Exp $
//@{
@@ -145,7 +145,7 @@
fprintf(LogFile,"(replay-log\n");
fprintf(LogFile," 'comment\t\"Generated by Stratagus Version " VERSION
"\"\n");
fprintf(LogFile," 'comment\t\"Visit http://Stratagus.Org for more
information\"\n");
- fprintf(LogFile," 'comment\t\"$Id: commands.c,v 1.65 2003/09/05
18:10:56 n0body Exp $\"\n");
+ fprintf(LogFile," 'comment\t\"$Id: commands.c,v 1.66 2003/09/18
11:59:21 mr-russ Exp $\"\n");
if( NetworkFildes==-1 ) {
fprintf(LogFile," 'type\t\"%s\"\n","single-player");
fprintf(LogFile," 'race\t%d\n",GameSettings.Presets[0].Race);
@@ -1451,7 +1451,5 @@
break;
}
}
-
-//@}
//@}
Index: stratagus/src/network/lowlevel.c
diff -u stratagus/src/network/lowlevel.c:1.33
stratagus/src/network/lowlevel.c:1.34
--- stratagus/src/network/lowlevel.c:1.33 Fri Jul 11 10:35:33 2003
+++ stratagus/src/network/lowlevel.c Thu Sep 18 07:59:21 2003
@@ -26,7 +26,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: lowlevel.c,v 1.33 2003/07/11 14:35:33 n0body Exp $
+// $Id: lowlevel.c,v 1.34 2003/09/18 11:59:21 mr-russ Exp $
//@{
@@ -701,7 +701,5 @@
NetLastPort=sa.sin_port;
return NetLastSocket;
}
-
-//@}
//@}
Index: stratagus/src/network/netconnect.c
diff -u stratagus/src/network/netconnect.c:1.72
stratagus/src/network/netconnect.c:1.73
--- stratagus/src/network/netconnect.c:1.72 Fri Jul 11 10:35:33 2003
+++ stratagus/src/network/netconnect.c Thu Sep 18 07:59:21 2003
@@ -26,7 +26,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: netconnect.c,v 1.72 2003/07/11 14:35:33 n0body Exp $
+// $Id: netconnect.c,v 1.73 2003/09/18 11:59:21 mr-russ Exp $
//@{
@@ -1753,7 +1753,5 @@
}
return 0;
}
-
-//@}
//@}
Index: stratagus/src/network/network.c
diff -u stratagus/src/network/network.c:1.115
stratagus/src/network/network.c:1.116
--- stratagus/src/network/network.c:1.115 Fri Jul 11 10:35:33 2003
+++ stratagus/src/network/network.c Thu Sep 18 07:59:21 2003
@@ -26,7 +26,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: network.c,v 1.115 2003/07/11 14:35:33 n0body Exp $
+// $Id: network.c,v 1.116 2003/09/18 11:59:21 mr-russ Exp $
//@{
@@ -1226,7 +1226,5 @@
}
}
}
-
-//@}
//@}
Index: stratagus/src/pathfinder/pathfinder.c
diff -u stratagus/src/pathfinder/pathfinder.c:1.54
stratagus/src/pathfinder/pathfinder.c:1.55
--- stratagus/src/pathfinder/pathfinder.c:1.54 Sun Sep 14 02:53:08 2003
+++ stratagus/src/pathfinder/pathfinder.c Thu Sep 18 07:59:21 2003
@@ -28,7 +28,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: pathfinder.c,v 1.54 2003/09/14 06:53:08 mr-russ Exp $
+// $Id: pathfinder.c,v 1.55 2003/09/18 11:59:21 mr-russ Exp $
//@{
@@ -157,7 +157,7 @@
** @param gy Y position of target area
** @param gw Width of target area
** @param gh Height of target area
-** @param rnage Range to search at
+** @param range Range to search at
** @param matrix Target area marked in matrix
**
** @returns depth, -1 unreachable
Index: stratagus/src/unit/ccl_unit.c
diff -u stratagus/src/unit/ccl_unit.c:1.66 stratagus/src/unit/ccl_unit.c:1.67
--- stratagus/src/unit/ccl_unit.c:1.66 Fri Sep 5 14:10:56 2003
+++ stratagus/src/unit/ccl_unit.c Thu Sep 18 07:59:21 2003
@@ -26,7 +26,7 @@
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
-// $Id: ccl_unit.c,v 1.66 2003/09/05 18:10:56 n0body Exp $
+// $Id: ccl_unit.c,v 1.67 2003/09/18 11:59:21 mr-russ Exp $
//@{
@@ -1041,8 +1041,7 @@
** @param type Unit-type of the unit,
** @param player Owning player number of the unit.
** @param quantity Number of units to kill.
-** @param loc1 Top left corner location.
-** @param loc2 Bottom right corner location.
+** @param loc Co-ordinates list (x1 y1 x2 y2)
**
** @return Returns the number of units killed.
*/
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Stratagus-CVS] stratagus/src clone/ccl.c clone/iolib.c clone/u...,
Russell Smith <=