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

1 files changed, 0 insertions, 57 deletions

diff --git a/src/newgrf_class.h b/src/newgrf_class.h
index 399efa27b..efbff9746 100644
--- a/src/newgrf_class.h
+++ b/src/newgrf_class.h
@@ -27,75 +27,18 @@ struct NewGRFClass {
 	/** The actual classes. */
 	static NewGRFClass<Tspec, Tid, Tmax> classes[Tmax];
 
-	/** Reset the classes, i.e. clear everything. */
 	static void Reset();
-
 	/** Initialise the defaults. */
 	static void InsertDefaults();
 
-	/**
-	 * Allocate a class with a given global class ID.
-	 * @param cls_id The global class id, such as 'DFLT'.
-	 * @return The (non global!) class ID for the class.
-	 * @note Upon allocating the same global class ID for a
-	 *       second time, this first allocation will be given.
-	 */
 	static Tid Allocate(uint32 global_id);
-
-	/**
-	 * Set the name of a particular class.
-	 * @param cls_id The id for the class.
-	 * @pre index < GetCount(cls_id)
-	 * @param name   The new name for the class.
-	 */
 	static void SetName(Tid cls_id, StringID name);
-
-	/**
-	 * Assign a spec to one of the classes.
-	 * @param spec The spec to assign.
-	 * @note The spec must have a valid class id set.
-	 */
 	static void Assign(Tspec *spec);
 
-
-	/**
-	 * Get the name of a particular class.
-	 * @param cls_id The class to get the name of.
-	 * @pre index < GetCount(cls_id)
-	 * @return The name of said class.
-	 */
 	static StringID GetName(Tid cls_id);
-
-	/**
-	 * Get the number of allocated classes.
-	 * @return The number of classes.
-	 */
 	static uint GetCount();
-
-	/**
-	 * Get the number of allocated specs within a particular class.
-	 * @param cls_id The class to get the size of.
-	 * @pre cls_id < GetCount()
-	 * @return The size of the class.
-	 */
 	static uint GetCount(Tid cls_id);
-
-	/**
-	 * Get a spec from a particular class at a given index.
-	 * @param cls_id The class to get the spec from.
-	 * @param index  The index where to find the spec.
-	 * @pre index < GetCount(cls_id)
-	 * @return The spec at given location.
-	 */
 	static const Tspec *Get(Tid cls_id, uint index);
-
-	/**
-	 * Retrieve a spec by GRF location.
-	 * @param grfid    GRF ID of spec.
-	 * @param local_id Index within GRF file of spec.
-	 * @param index    Pointer to return the index of the spec in its class. If NULL then not used.
-	 * @return The spec.
-	 */
 	static const Tspec *GetByGrf(uint32 grfid, byte local_id, int *index);
 };