(svn r21846) -Codechange: move documentation towards the code to make it more likely to be updated [o-s].

1 files changed, 0 insertions, 56 deletions

diff --git a/src/order_backup.h b/src/order_backup.h
index 3e87b99d9..51281e860 100644
--- a/src/order_backup.h
+++ b/src/order_backup.h
@@ -51,77 +51,21 @@ private:
 
 	/** Creation for savegame restoration. */
 	OrderBackup() {}
-
-	/**
-	 * Create an order backup for the given vehicle.
-	 * @param v    The vehicle to make a backup of.
-	 * @param user The user that is requesting the backup.
-	 */
 	OrderBackup(const Vehicle *v, uint32 user);
 
-	/**
-	 * Restore the data of this order to the given vehicle.
-	 * @param v The vehicle to restore to.
-	 */
 	void DoRestore(Vehicle *v);
 
 public:
-	/** Free everything that is allocated. */
 	~OrderBackup();
 
-	/**
-	 * Create an order backup for the given vehicle.
-	 * @param v    The vehicle to make a backup of.
-	 * @param user The user that is requesting the backup.
-	 * @note Will automatically remove any previous backups of this user.
-	 */
 	static void Backup(const Vehicle *v, uint32 user);
-
-	/**
-	 * Restore the data of this order to the given vehicle.
-	 * @param v    The vehicle to restore to.
-	 * @param user The user that built the vehicle, thus wants to restore.
-	 * @note After restoration the backup will automatically be removed.
-	 */
 	static void Restore(Vehicle *v, uint32 user);
 
-	/**
-	 * Reset an OrderBackup given a tile and user.
-	 * @param tile The tile associated with the OrderBackup.
-	 * @param user The user associated with the OrderBackup.
-	 * @note Must not be used from the GUI!
-	 */
 	static void ResetOfUser(TileIndex tile, uint32 user);
-
-	/**
-	 * Reset an user's OrderBackup if needed.
-	 * @param user The user associated with the OrderBackup.
-	 * @pre _network_server.
-	 * @note Must not be used from a command.
-	 */
 	static void ResetUser(uint32 user);
-
-	/**
-	 * Reset the OrderBackups from GUI/game logic.
-	 * @param tile     The tile of the order backup.
-	 * @param from_gui Whether the call came from the GUI, i.e. whether
-	 *                 it must be synced over the network.
-	 */
 	static void Reset(TileIndex tile = INVALID_TILE, bool from_gui = true);
 
-	/**
-	 * Clear the group of all backups having this group ID.
-	 * @param group The group to clear.
-	 */
 	static void ClearGroup(GroupID group);
-
-	/**
-	 * Clear/update the (clone) vehicle from an order backup.
-	 * @param v The vehicle to clear.
-	 * @pre v != NULL
-	 * @note If it is not possible to set another vehicle as clone
-	 *       "example", then this backed up order will be removed.
-	 */
 	static void ClearVehicle(const Vehicle *v);
 };