(svn r22405) -Document: some more "random-ish" tidbits

1 files changed, 7 insertions, 0 deletions

diff --git a/src/townname.cpp b/src/townname.cpp
index 042ede98d..ef6cd2603 100644
--- a/src/townname.cpp
+++ b/src/townname.cpp
@@ -989,6 +989,13 @@ static char *MakeCatalanTownName(char *buf, const char *last, uint32 seed)
 }
 
 
+/**
+ * Type for all town name generator functions.
+ * @param buf  The buffer to write the name to.
+ * @param last The last element of the buffer.
+ * @param seed The seed of the town name.
+ * @return The end of the filled buffer.
+ */
 typedef char *TownNameGenerator(char *buf, const char *last, uint32 seed);
 
 /** Contains pointer to generator and minimum buffer size (not incl. terminating '\0') */