Skip to content

Commit 13bb5ca

Browse files
committed
Docs: fix GetWarnings docs to reflect behavior
In "gui", it returns all warnings, joined by a separator In "statusbar", it returns just the first warning
1 parent 26f59f5 commit 13bb5ca

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/warnings.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ void SetfLargeWorkForkFound(bool flag);
1414
bool GetfLargeWorkForkFound();
1515
void SetfLargeWorkInvalidChainFound(bool flag);
1616
/** Format a string that describes several potential problems detected by the core.
17-
* strFor can have three values:
18-
* - "statusbar": get all warnings
19-
* - "gui": get all warnings, translated (where possible) for GUI
20-
* This function only returns the highest priority warning of the set selected by strFor.
17+
* @param[in] strFor can have the following values:
18+
* - "statusbar": get the most important warning
19+
* - "gui": get all warnings, translated (where possible) for GUI, separated by <hr />
20+
* @returns the warning string selected by strFor
2121
*/
2222
std::string GetWarnings(const std::string& strFor);
2323

0 commit comments

Comments
 (0)