LBRYCommunity/lbrycrd
1
0
Fork 0
Code Issues 29 Pull requests 1 Projects Releases 32 Packages Wiki Activity

Docs: fix GetWarnings docs to reflect behavior

Browse source 
In "gui", it returns all warnings, joined by a separator
In "statusbar", it returns just the first warning
This commit is contained in:
Ben Woosley 2018-08-06 17:06:56 -04:00
parent 26f59f5054
commit 13bb5cae31
No known key found for this signature in database
GPG key ID: 6EE5F3785F78B345
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/warnings.h
View file

@ -14,10 +14,10 @@ void SetfLargeWorkForkFound(bool flag);
bool GetfLargeWorkForkFound();
void SetfLargeWorkInvalidChainFound(bool flag);
/** Format a string that describes several potential problems detected by the core.
* strFor can have three values:
* - "statusbar": get all warnings
* - "gui": get all warnings, translated (where possible) for GUI
* This function only returns the highest priority warning of the set selected by strFor.
* @param[in] strFor can have the following values:
* - "statusbar": get the most important warning
* - "gui": get all warnings, translated (where possible) for GUI, separated by <hr />
* @returns the warning string selected by strFor
*/
std::string GetWarnings(const std::string& strFor);