mirror of https://github.com/OpenTTD/OpenTTD.git
(svn r20025) -Doc: Fix/add comments to let Doxygen know about the documentation.
This commit is contained in:
parent
b3a707ae4b
commit
604e56adc2
|
@ -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;
|
||||
|
|
|
@ -1718,8 +1718,10 @@ static const WindowDesc _network_lobby_window_desc(
|
|||
_nested_network_lobby_window_widgets, lengthof(_nested_network_lobby_window_widgets)
|
||||
);
|
||||
|
||||
/* Show the networklobbywindow with the selected server
|
||||
* @param ngl Selected game pointer which is passed to the new window */
|
||||
/**
|
||||
* Show the networklobbywindow with the selected server.
|
||||
* @param ngl Selected game pointer which is passed to the new window.
|
||||
*/
|
||||
static void ShowNetworkLobbyWindow(NetworkGameList *ngl)
|
||||
{
|
||||
DeleteWindowById(WC_NETWORK_WINDOW, 0);
|
||||
|
|
|
@ -20,6 +20,7 @@
|
|||
|
||||
#define SIZE_MAX ((size_t)-1)
|
||||
|
||||
/** Save or load result codes. */
|
||||
enum SaveOrLoadResult {
|
||||
SL_OK = 0, ///< completed successfully
|
||||
SL_ERROR = 1, ///< error that was caught before internal structures were modified
|
||||
|
@ -36,6 +37,7 @@ enum SaveOrLoadMode {
|
|||
SL_LOAD_CHECK = 5,
|
||||
};
|
||||
|
||||
/** Types of save games. */
|
||||
enum SavegameType {
|
||||
SGT_TTD, ///< TTD savegame (can be detected incorrectly)
|
||||
SGT_TTDP1, ///< TTDP savegame ( -//- ) (data at NW border)
|
||||
|
@ -276,19 +278,23 @@ static inline bool SlIsObjectCurrentlyValid(uint16 version_from, uint16 version_
|
|||
return true;
|
||||
}
|
||||
|
||||
/* Get the NumberType of a setting. This describes the integer type
|
||||
/**
|
||||
* Get the NumberType of a setting. This describes the integer type
|
||||
* as it is represented in memory
|
||||
* @param type VarType holding information about the variable-type
|
||||
* @return return the SLE_VAR_* part of a variable-type description */
|
||||
* @return return the SLE_VAR_* part of a variable-type description
|
||||
*/
|
||||
static inline VarType GetVarMemType(VarType type)
|
||||
{
|
||||
return type & 0xF0; // GB(type, 4, 4) << 4;
|
||||
}
|
||||
|
||||
/* Get the FileType of a setting. This describes the integer type
|
||||
/**
|
||||
* Get the FileType of a setting. This describes the integer type
|
||||
* as it is represented in a savegame/file
|
||||
* @param type VarType holding information about the variable-type
|
||||
* @param return the SLE_FILE_* part of a variable-type description */
|
||||
* @param return the SLE_FILE_* part of a variable-type description
|
||||
*/
|
||||
static inline VarType GetVarFileType(VarType type)
|
||||
{
|
||||
return type & 0xF; // GB(type, 0, 4);
|
||||
|
|
|
@ -300,7 +300,8 @@ char *md5sumToString(char *buf, const char *last, const uint8 md5sum[16])
|
|||
/* UTF-8 handling routines */
|
||||
|
||||
|
||||
/* Decode and consume the next UTF-8 encoded character
|
||||
/**
|
||||
* Decode and consume the next UTF-8 encoded character.
|
||||
* @param c Buffer to place decoded character.
|
||||
* @param s Character stream to retrieve character from.
|
||||
* @return Number of characters in the sequence.
|
||||
|
@ -339,7 +340,8 @@ size_t Utf8Decode(WChar *c, const char *s)
|
|||
}
|
||||
|
||||
|
||||
/* Encode a unicode character and place it in the buffer
|
||||
/**
|
||||
* Encode a unicode character and place it in the buffer.
|
||||
* @param buf Buffer to place character.
|
||||
* @param c Unicode character to encode.
|
||||
* @return Number of characters in the encoded sequence.
|
||||
|
|
|
@ -410,7 +410,8 @@ static Vehicle *EnsureNoVehicleProcZ(Vehicle *v, void *data)
|
|||
return v;
|
||||
}
|
||||
|
||||
/* Ensure there is no vehicle at the ground at the given position.
|
||||
/**
|
||||
* Ensure there is no vehicle at the ground at the given position.
|
||||
* @param tile Position to examine.
|
||||
* @return Succeeded command (ground is free) or failed command (a vehicle is found).
|
||||
*/
|
||||
|
|
Loading…
Reference in New Issue