Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document SaveAnimation, remove documentation for remaining methods

Browse Source 
They've been deemed implementation details
This commit is contained in:
Samuel Dunn
2017-06-25 14:06:47 -07:00
parent cd203ca2fd
commit 565bf4d155
1 changed files with 3 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
interface/wx/imaggif.h
View File

@@ -38,6 +38,9 @@ public:
Opened output stream for writing the data. Opened output stream for writing the data.
@param verbose @param verbose
If set to @true, errors reported by the image handler will produce wxLogMessages 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 @return @true if the operation was successful, @false otherwise
*/ */
@@ -48,17 +51,4 @@ protected:
// allow parent class documentation to overwrite. // allow parent class documentation to overwrite.
virtual int DoGetImageCount(wxInputStream& stream); virtual int DoGetImageCount(wxInputStream& stream);
virtual bool DoCanRead(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);
}; };