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().
This commit is contained in:
Ben Harris
2022-12-05 12:49:51 +00:00
parent 8d81c1814d
commit 493d2fb138

View File

@ -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()}