aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Harris <bjh21@bjh21.me.uk>2022-12-05 12:49:51 +0000
committerBen Harris <bjh21@bjh21.me.uk>2022-12-05 23:24:45 +0000
commit493d2fb138ba64faf795e1b4c01fd4f0d49075fc (patch)
treeda515d9abce7f44c2c72e6a9f0f85e4060018ae1
parent8d81c1814d249d3aa2342c02363a0220c54bf71c (diff)
downloadpuzzles-493d2fb138ba64faf795e1b4c01fd4f0d49075fc.zip
puzzles-493d2fb138ba64faf795e1b4c01fd4f0d49075fc.tar.gz
puzzles-493d2fb138ba64faf795e1b4c01fd4f0d49075fc.tar.bz2
puzzles-493d2fb138ba64faf795e1b4c01fd4f0d49075fc.tar.xz
Devel docs: make it clear that decode_ui() gets a new game_ui
At least one puzzle does no actual decoding in decode_ui, but does re-initialise some fields. This is unnecessary because the mid-end only calls decode_ui() with a game_ui it just allocated using new_ui().
-rw-r--r--devel.but4
1 files changed, 2 insertions, 2 deletions
diff --git a/devel.but b/devel.but
index 283e48c..4b7988a 100644
--- a/devel.but
+++ b/devel.but
@@ -890,8 +890,8 @@ source.)
\c void (*decode_ui)(game_ui *ui, const char *encoding);
This function parses a string previously output by \cw{encode_ui()},
-and writes the decoded data back into the provided \c{game_ui}
-structure.
+and writes the decoded data back into the freshly-created \c{game_ui}
+structure provided.
\S{backend-changed-state} \cw{changed_state()}