(svn r20025) -Doc: Fix/add comments to let Doxygen know about the documentation.

This commit is contained in:
alberth
2010-06-27 09:05:10 +00:00
parent 065e2f027c
commit 0dd71a0d7e
5 changed files with 25 additions and 12 deletions

View File

@@ -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;