From 428044e0335e0ff3cfd2fd3ef86e024e389e5057 Mon Sep 17 00:00:00 2001
From: rubidium <rubidium@openttd.org>
Date: Sun, 1 May 2011 20:04:09 +0000
Subject: (svn r22407) -Document: the "root" driver related stuff

---
 src/driver.cpp | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'src/driver.cpp')

diff --git a/src/driver.cpp b/src/driver.cpp
index 8cab88fad..448320c83 100644
--- a/src/driver.cpp
+++ b/src/driver.cpp
@@ -31,6 +31,12 @@ char *_ini_musicdriver;     ///< The music driver a stored in the configuration
 
 char *_ini_blitter;         ///< The blitter as stored in the configuration file.
 
+/**
+ * Get a string parameter the list of parameters.
+ * @param parm The parameters.
+ * @param name The parameter name we're looking for.
+ * @return The parameter value.
+ */
 const char *GetDriverParam(const char * const *parm, const char *name)
 {
 	size_t len;
@@ -49,11 +55,24 @@ const char *GetDriverParam(const char * const *parm, const char *name)
 	return NULL;
 }
 
+/**
+ * Get a boolean parameter the list of parameters.
+ * @param parm The parameters.
+ * @param name The parameter name we're looking for.
+ * @return The parameter value.
+ */
 bool GetDriverParamBool(const char * const *parm, const char *name)
 {
 	return GetDriverParam(parm, name) != NULL;
 }
 
+/**
+ * Get an integer parameter the list of parameters.
+ * @param parm The parameters.
+ * @param name The parameter name we're looking for.
+ * @param def  The default value if the parameter doesn't exist.
+ * @return The parameter value.
+ */
 int GetDriverParamInt(const char * const *parm, const char *name, int def)
 {
 	const char *p = GetDriverParam(parm, name);
@@ -173,6 +192,9 @@ void DriverFactoryBase::RegisterDriver(const char *name, Driver::Type type, int
 
 /**
  * Build a human readable list of available drivers, grouped by type.
+ * @param p The buffer to write to.
+ * @param last The last element in the buffer.
+ * @return The end of the written buffer.
  */
 char *DriverFactoryBase::GetDriversInfo(char *p, const char *last)
 {
-- 
cgit v1.2.3-54-g00ecf