aboutsummaryrefslogtreecommitdiff
path: root/src/warnings.h
diff options
context:
space:
mode:
authorBen Woosley <ben.woosley@gmail.com>2018-08-06 17:06:56 -0400
committerBen Woosley <ben.woosley@gmail.com>2018-08-06 17:16:15 -0400
commit13bb5cae31a699b4c3f8b71501e9967c6938600c (patch)
tree932afcd3eaaaedefc7409519d90eeb14b96655d6 /src/warnings.h
parent26f59f5054ef4c045e24be0fd222c39e46670c51 (diff)
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
Diffstat (limited to 'src/warnings.h')
-rw-r--r--src/warnings.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/warnings.h b/src/warnings.h
index 904e8c0440..f1bdc008cf 100644
--- a/src/warnings.h
+++ b/src/warnings.h
@@ -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);