summaryrefslogtreecommitdiff
path: root/src/fios.cpp
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2010-06-27 09:05:10 +0000
committeralberth <alberth@openttd.org>2010-06-27 09:05:10 +0000
commit604e56adc2092d31c02f16b8412d550f7986557c (patch)
treeeb4fc60536488e1ce18a774eba7978abbbfc60e3 /src/fios.cpp
parentb3a707ae4b39ff832236dfcb786fbe3461ce0e1b (diff)
downloadopenttd-604e56adc2092d31c02f16b8412d550f7986557c.tar.xz
(svn r20025) -Doc: Fix/add comments to let Doxygen know about the documentation.
Diffstat (limited to 'src/fios.cpp')
-rw-r--r--src/fios.cpp8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/fios.cpp b/src/fios.cpp
index 398c7c7e3..e1badddf3 100644
--- a/src/fios.cpp
+++ b/src/fios.cpp
@@ -84,9 +84,11 @@ StringID FiosGetDescText(const char **path, uint64 *total_free)
return FiosGetDiskFreeSpace(*path, total_free) ? STR_SAVELOAD_BYTES_FREE : STR_ERROR_UNABLE_TO_READ_DRIVE;
}
-/* Browse to a new path based on the passed FiosItem struct
- * @param *item FiosItem object telling us what to do
- * @return a string if we have given a file as a target, otherwise NULL */
+/**
+ * Browse to a new path based on the passed \a item.
+ * @param *item #FiosItem object telling us what to do.
+ * @return A string if we have given a file as a target, otherwise \c NULL.
+ */
const char *FiosBrowseTo(const FiosItem *item)
{
char *path = _fios_path;