project_files/frontlib/model/weapon.h
changeset 7224 5143861c83bd
parent 7177 bf6cf4dd847a
child 7230 240620f46dd7
--- a/project_files/frontlib/model/weapon.h	Mon Jun 11 00:06:22 2012 +0200
+++ b/project_files/frontlib/model/weapon.h	Tue Jun 12 11:25:05 2012 +0200
@@ -7,7 +7,7 @@
  * These values are all in the range 0..9
  *
  * For loadout, 9 means inifinite ammo.
- * For the other setting, 9 might actually be invalid, it's not possible to set more than 8 in the QtFrontend. (TODO)
+ * For the other setting, 9 is invalid.
  */
 typedef struct {
 	char loadout[WEAPONS_COUNT+1];
@@ -25,7 +25,16 @@
  * settings (see hwconsts.h)
  */
 flib_weaponset *flib_weaponset_create(const char *name);
+
+/**
+ * Loads a weapon set, returns NULL on error.
+ */
 flib_weaponset *flib_weaponset_from_ini(const char *filename);
+
+/**
+ * Write the weapon set to an ini file. Attempts to
+ * retain extra ini settings that were already present.
+ */
 int flib_weaponset_to_ini(const char *filename, const flib_weaponset *set);
 void flib_weaponset_destroy(flib_weaponset *set);