src/ai/api/ai_date.hpp
branchnoai
changeset 9835 2541c2d325ed
parent 9829 80fbe02a4184
--- a/src/ai/api/ai_date.hpp	Mon Mar 31 06:48:59 2008 +0000
+++ b/src/ai/api/ai_date.hpp	Mon Mar 31 07:21:39 2008 +0000
@@ -24,39 +24,39 @@
 	/**
 	 * Get the current date.
 	 * This is the number of days since epoch under the assumption that
-	 * there is a leap year every 4 years, except when dividable by
-	 * 100 but not by 400.
-	 * @return a date.
+	 *  there is a leap year every 4 years, except when dividable by
+	 *  100 but not by 400.
+	 * @return The current date.
 	 */
 	static int32 GetCurrentDate();
 
 	/**
 	 * Get the year of the given date.
-	 * @param date the date to get the year of.
-	 * @return the year.
+	 * @param date The date to get the year of.
+	 * @return The year.
 	 */
 	static int32 GetYear(int32 date);
 
 	/**
 	 * Get the month of the given date.
-	 * @param date the date to get the month of.
-	 * @return the month.
+	 * @param date The date to get the month of.
+	 * @return The month.
 	 */
 	static int32 GetMonth(int32 date);
 
 	/**
 	 * Get the day (of the month) of the given date.
-	 * @param date the date to get the day of.
-	 * @return the day.
+	 * @param date The date to get the day of.
+	 * @return The day.
 	 */
 	static int32 GetDayOfMonth(int32 date);
 
 	/**
 	 * Get the date given a year, month and day of month.
-	 * @param year the year of the to-be determined date.
-	 * @param month the month of the to-be determined date.
-	 * @param day_of_month the day of month of the to-be determined date.
-	 * @return the date.
+	 * @param year The year of the to-be determined date.
+	 * @param month The month of the to-be determined date.
+	 * @param day_of_month The day of month of the to-be determined date.
+	 * @return The date.
 	 */
 	static int32 GetDate(int32 year, int32 month, int32 day_of_month);
 };