aboutsummaryrefslogtreecommitdiff
path: root/html
diff options
context:
space:
mode:
authorSimon Tatham <anakin@pobox.com>2022-07-31 13:48:42 +0100
committerSimon Tatham <anakin@pobox.com>2022-07-31 15:31:58 +0100
commit89391ba66a2fd3826e16dc288eaa1a1516b1e9de (patch)
treeb1be1236036db0cb543fae18c87f5faae3e1509f /html
parentb34f8b1ee33163af988c75587e6ac99739b7684f (diff)
downloadpuzzles-89391ba66a2fd3826e16dc288eaa1a1516b1e9de.zip
puzzles-89391ba66a2fd3826e16dc288eaa1a1516b1e9de.tar.gz
puzzles-89391ba66a2fd3826e16dc288eaa1a1516b1e9de.tar.bz2
puzzles-89391ba66a2fd3826e16dc288eaa1a1516b1e9de.tar.xz
Update the developer documentation.
It's got a bit out of date over the years, with some changes to the code not fully reflected in it (e.g. not all the int -> bool type changes were documented, and TRUE and FALSE were still mentioned), and quite a lot of new functions not added. (In particular, the dsf API was not documented, and it certainly should have been, if only so that people can find out what it even stands for!) As well as correcting for factual accuracy, two content changes in the advice chapter: I've reworded the definition of 'fairness' to explicitly mention that requiring the player to use Undo is cheating. That's always how I _intended_ the definition, but I didn't say it clearly enough. And I've added an entire new section describing the normal sensible way to implement redraw(), via a loop of the form 'work out what this cell should look like, check it against an array in game_drawstate of the last state we drew it in, and if they're different, call a redraw function'. That was mentioned in passing in two other sections, but I know at least one developer didn't find it, so now it's less well hidden.
Diffstat (limited to 'html')
0 files changed, 0 insertions, 0 deletions