summaryrefslogtreecommitdiff
path: root/src/screenshot.cpp
diff options
context:
space:
mode:
authorTechGeekNZ <git@tech.geek.nz>2020-06-20 17:12:31 +1200
committerCharles Pigott <charlespigott@googlemail.com>2020-06-27 14:19:35 +0100
commit3c8d0aa3544602dd8e34ec8ffcdc12cfc7f73b3f (patch)
tree89368edbecf3ff2de5c295ccbc21892558d26b7a /src/screenshot.cpp
parented6f31f601ef92e098f5555e9bb2b1492c5a7e79 (diff)
downloadopenttd-3c8d0aa3544602dd8e34ec8ffcdc12cfc7f73b3f.tar.xz
Cleanup: Give `TakeScreenshot` a more sensible name
Diffstat (limited to 'src/screenshot.cpp')
-rw-r--r--src/screenshot.cpp10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/screenshot.cpp b/src/screenshot.cpp
index d2bb6a1f3..c89586226 100644
--- a/src/screenshot.cpp
+++ b/src/screenshot.cpp
@@ -845,12 +845,12 @@ static void ScreenshotConfirmationCallback(Window *w, bool confirmed)
}
/**
- * Take a screenshot.
- * Ask for confirmation if the screenshot will be huge. Delegates to \c MakeScreenshot to perform the action.
+ * Make a screenshot.
+ * Ask for confirmation first if the screenshot will be huge.
* @param t Screenshot type: World, defaultzoom, heightmap or viewport screenshot
* @see MakeScreenshot
*/
-void TakeScreenshot(ScreenshotType t)
+void MakeScreenshotWithConfirm(ScreenshotType t)
{
ViewPort vp;
SetupScreenshotViewport(t, &vp);
@@ -868,11 +868,11 @@ void TakeScreenshot(ScreenshotType t)
/**
* Make a screenshot.
- * No questions asked, just do it.
+ * Unconditionally take a screenshot of the requested type.
* @param t the type of screenshot to make.
* @param name the name to give to the screenshot.
* @return true iff the screenshot was made successfully
- * @see TakeScreenshot
+ * @see MakeScreenshotWithConfirm
*/
bool MakeScreenshot(ScreenshotType t, const char *name)
{