From b992a939966dfe50e16688d1f30767a50b2d2bc5 Mon Sep 17 00:00:00 2001
From: alberth <alberth@openttd.org>
Date: Sat, 5 Feb 2011 16:20:55 +0000
Subject: (svn r21976) -Doc: Document several crash handling functions.

---
 src/train_cmd.cpp | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'src/train_cmd.cpp')

diff --git a/src/train_cmd.cpp b/src/train_cmd.cpp
index 883f46fae..506845d59 100644
--- a/src/train_cmd.cpp
+++ b/src/train_cmd.cpp
@@ -3299,6 +3299,10 @@ static void DeleteLastWagon(Train *v)
 	}
 }
 
+/**
+ * Rotate all vehicles of a (crashed) train chain randomly to animate the crash.
+ * @param v First crashed vehicle.
+ */
 static void ChangeTrainDirRandomly(Train *v)
 {
 	static const DirDiff delta[] = {
@@ -3319,6 +3323,11 @@ static void ChangeTrainDirRandomly(Train *v)
 	} while ((v = v->Next()) != NULL);
 }
 
+/**
+ * Handle a crashed train.
+ * @param v First train vehicle.
+ * @return %Vehicle chain still exists.
+ */
 static bool HandleCrashedTrain(Train *v)
 {
 	int state = ++v->crash_anim_pos;
-- 
cgit v1.2.3-54-g00ecf