We are currently migrating Bugzilla to GitHub issues.
Any changes made to the bug tracker now will be lost, so please do not post new bugs or make changes to them.
When we're done, all bug URLs will redirect to their equivalent location on the new bug tracker.

Bug 4153 - developers should update documentation
Summary: developers should update documentation
Status: NEW
Alias: None
Product: SDL_image
Classification: Unclassified
Component: misc (show other bugs)
Version: unspecified
Hardware: All All
: P2 normal
Assignee: Sam Lantinga
QA Contact: Sam Lantinga
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-05-01 18:03 UTC by N. de Jonge
Modified: 2018-05-01 18:03 UTC (History)
0 users

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description N. de Jonge 2018-05-01 18:03:44 UTC 
The SDL_image documentation hasn't been updated since 2009 (v1.2.8).

This is not a GUI-based end-user product, but a library for developers.

The authors of SDL_image should keep the documentation up-to-date. If an author adds, for example, IMG_SavePNG(), then that author should also document this function. Accepted parameters, expected return values, etc.

In my opinion, this is not something that (other) volunteers should do. If a function is added, removed or modified, then the documentation should be altered to reflect the changes.