diff options
author | alberth <alberth@openttd.org> | 2010-03-14 12:39:24 +0000 |
---|---|---|
committer | alberth <alberth@openttd.org> | 2010-03-14 12:39:24 +0000 |
commit | 777123c228e163c976303be0588093732816f8ca (patch) | |
tree | 166d1561b235145728ce4ab16617dc600f9a759f /src/command.cpp | |
parent | b8d6e893cb25cf605392fee7c45f2909563f7bcd (diff) | |
download | openttd-777123c228e163c976303be0588093732816f8ca.tar.xz |
(svn r19414) -Doc: Several doxygen additions and corrections.
Diffstat (limited to 'src/command.cpp')
-rw-r--r-- | src/command.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/command.cpp b/src/command.cpp index eb992a2d2..ccea6821d 100644 --- a/src/command.cpp +++ b/src/command.cpp @@ -29,7 +29,7 @@ #include "table/strings.h" -StringID _error_message; +StringID _error_message; ///< Global error message. @see CommandCost::SetGlobalErrorMessage() CommandProc CmdBuildRailroadTrack; CommandProc CmdRemoveRailroadTrack; @@ -192,7 +192,7 @@ CommandProc CmdSetTimetableStart; * The master command table * * This table contains all possible CommandProc functions with - * the flags which belongs to it. The indizes are the same + * the flags which belongs to it. The indices are the same * as the value from the CMD_* enums. */ static const Command _command_proc_table[] = { @@ -472,8 +472,8 @@ bool DoCommandP(const CommandContainer *container, bool my_cmd) /*! * Toplevel network safe docommand function for the current company. Must not be called recursively. * The callback is called when the command succeeded or failed. The parameters - * tile, p1 and p2 are from the #CommandProc function. The paramater cmd is the command to execute. - * The parameter my_cmd is used to indicate if the command is from a company or the server. + * \a tile, \a p1, and \a p2 are from the #CommandProc function. The parameter \a cmd is the command to execute. + * The parameter \a my_cmd is used to indicate if the command is from a company or the server. * * @param tile The tile to perform a command on (see #CommandProc) * @param p1 Additional data for the command (see #CommandProc) @@ -482,7 +482,7 @@ bool DoCommandP(const CommandContainer *container, bool my_cmd) * @param callback A callback function to call after the command is finished * @param text The text to pass * @param my_cmd indicator if the command is from a company or server (to display error messages for a user) - * @return true if the command succeeded, else false + * @return \c true if the command succeeded, else \c false. */ bool DoCommandP(TileIndex tile, uint32 p1, uint32 p2, uint32 cmd, CommandCallback *callback, const char *text, bool my_cmd) { |