From 565bf4d155e5b28212d500e6af527f3c41267635 Mon Sep 17 00:00:00 2001 From: Samuel Dunn Date: Sun, 25 Jun 2017 14:06:47 -0700 Subject: [PATCH] Document SaveAnimation, remove documentation for remaining methods They've been deemed implementation details --- interface/wx/imaggif.h | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/interface/wx/imaggif.h b/interface/wx/imaggif.h index 7e04c604a2..19989f1420 100644 --- a/interface/wx/imaggif.h +++ b/interface/wx/imaggif.h @@ -38,6 +38,9 @@ public: Opened output stream for writing the data. @param verbose If set to @true, errors reported by the image handler will produce wxLogMessages + @param delayMilliSecs + How long, in milliseconds, to wait between each frame. + @return @true if the operation was successful, @false otherwise */ @@ -48,17 +51,4 @@ protected: // allow parent class documentation to overwrite. virtual int DoGetImageCount(wxInputStream& stream); virtual bool DoCanRead(wxInputStream& stream); - - // TODO: document these as necessary - bool DoSaveFile(const wxImage&, wxOutputStream *, bool verbose, - bool first, int delayMilliSecs, bool loop, - const wxRGB *pal, int palCount, - int mask_index); - bool InitHashTable(); - void ClearHashTable(); - void InsertHashTable(unsigned long key, int code); - int ExistsHashTable(unsigned long key); - bool CompressOutput(wxOutputStream *, int code); - bool SetupCompress(wxOutputStream *, int bpp); - bool CompressLine(wxOutputStream *, const wxUint8 *line, int lineLen); }; \ No newline at end of file