(svn r20283) -Codechange: Unify start of doygen comments.

This commit is contained in:
frosch
2010-08-01 19:22:34 +00:00
parent 1c83b21e90
commit 5b86c79fce
162 changed files with 1304 additions and 652 deletions

View File

@@ -899,7 +899,8 @@ struct TooltipsWindow : public Window
}
};
/** Shows a tooltip
/**
* Shows a tooltip
* @param str String to be displayed
* @param paramcount number of params to deal with
* @param params (optional) up to 5 pieces of additional information that may be added to a tooltip
@@ -1410,7 +1411,8 @@ static const WindowDesc _query_string_desc(
_nested_query_string_widgets, lengthof(_nested_query_string_widgets)
);
/** Show a query popup window with a textbox in it.
/**
* Show a query popup window with a textbox in it.
* @param str StringID for the text shown in the textbox
* @param caption StringID of text shown in caption of querywindow
* @param maxsize maximum size in bytes (including terminating '\0')
@@ -1564,7 +1566,8 @@ static const WindowDesc _query_desc(
_nested_query_widgets, lengthof(_nested_query_widgets)
);
/** Show a modal confirmation window with standard 'yes' and 'no' buttons
/**
* Show a modal confirmation window with standard 'yes' and 'no' buttons
* The window is aligned to the centre of its parent.
* @param caption string shown as window caption
* @param message string that will be shown for the window