From 6c9078fd30097b38537a60fbecb9828da69c3517 Mon Sep 17 00:00:00 2001
From: rubidium <rubidium@openttd.org>
Date: Tue, 18 Jan 2011 22:17:15 +0000
Subject: (svn r21844) -Codechange: move documentation towards the code to make
 it more likely to be updates [a-c].

---
 src/cheat.cpp | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/cheat.cpp')

diff --git a/src/cheat.cpp b/src/cheat.cpp
index a7e967a98..a0df14982 100644
--- a/src/cheat.cpp
+++ b/src/cheat.cpp
@@ -19,6 +19,10 @@ void InitializeCheats()
 	memset(&_cheats, 0, sizeof(Cheats));
 }
 
+/**
+ * Return true if any cheat has been used, false otherwise
+ * @return has a cheat been used?
+ */
 bool CheatHasBeenUsed()
 {
 	/* Cannot use lengthof because _cheats is of type Cheats, not Cheat */
-- 
cgit v1.2.3-70-g09d2