Merge #13895: Docs: fix GetWarnings docs to reflect behavior
13bb5cae31
Docs: fix GetWarnings docs to reflect behavior (Ben Woosley)
Pull request description:
In "gui", it returns all warnings, joined by a separator
In "statusbar", it returns the last warning set which seems notionally to be the most important, though that is debatable
Tree-SHA512: 5fc0dc68d143a040b7b893b7176188e2b064c2cf1d559420906e4de636e16e9ab7451a1b87603020a7a8f66d6b94f4ee6c7da2697efad879f9e6de9c0e0c9ac1
This commit is contained in:
commit
1cd5f2cf9a
1 changed files with 4 additions and 4 deletions
|
@ -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);
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue