Fix cases of people not updating the documentation when refactoring

This commit is contained in:
Ignacio R. Morelle 2016-02-20 20:47:40 -03:00
parent 1e167aaa66
commit c04bb94149
4 changed files with 8 additions and 7 deletions

View file

@ -39,7 +39,7 @@ public:
/**
* Constructor.
*
* @param disp Display object on which to display a status dialog.
* @param v Target for UI rendering for the progress dialog.
* @param address Add-ons server host address (i.e. localhost:15999).
*/
addons_client(CVideo& v, const std::string& address);

View file

@ -1226,7 +1226,7 @@ bool manage_addons(CVideo& v)
}
}
bool ad_hoc_addon_fetch_session(CVideo & v, const std::vector<std::string> & addon_ids)
bool ad_hoc_addon_fetch_session(CVideo& v, const std::vector<std::string>& addon_ids)
{
std::string remote_address = preferences::campaign_server();

View file

@ -25,7 +25,7 @@ class CVideo;
/**
* Shows the add-ons server connection dialog, for access to the various management front-ends.
*
* @param disp Display object on which to render UI elements.
* @param v Target for UI rendering.
*
* @return @a true when one or more add-ons have been successfully installed or
* removed, thus requiring a local WML cache refresh. @a false otherwise.
@ -36,11 +36,11 @@ bool manage_addons(CVideo& v);
* Conducts an ad-hoc add-ons server connection to download an add-on with a particular id and all
* it's dependencies. Launches gui dialogs when issues arise.
*
* @param disp Display object on which to render UI elements.
* @param v Target for UI rendering.
* @param addon_ids The ids of the target add-on.
*
* @return @a true when we successfully installed the target (possibly the user chose to ignore failures)
*/
bool ad_hoc_addon_fetch_session(CVideo & v, const std::vector<std::string> & addon_ids);
bool ad_hoc_addon_fetch_session(CVideo& v, const std::vector<std::string>& addon_ids);
#endif

View file

@ -130,9 +130,10 @@ struct twml_exception
/**
* Shows the error in a dialog.
* @param disp The display object to show the message on.
*
* @param video Target for rendering the UI message.
*/
void show(CVideo &video);
void show(CVideo& video);
private:
IMPLEMENT_LUA_JAILBREAK_EXCEPTION(twml_exception)
};