Re: [Openexr-devel] please clean up the sdk in future releases

[Florian Kainz]

Christopher Lux wrote:
> Hi,
> i would like a much more clean API for future releases plus: please separate
> the core lib from something like tests or examples, because compiling this
> ends up in a big mess for me. [...]
>
> And another point is documentation. If anyone should use this API, there
> should be at least some more as that on the openexr site...
>
> thx ;) an Best Regards...

Hi Christopher,

do you have specific suggestions for cleaning up the API?
What should be different?

Core library, tests and examples are separate.  We distribute
the tests together with the core so that you can easily check
if the compiled library actually works.  We don't want you to
accidentally build a library that ends up mangling your images.

About documentation: The details.html and api.html files (on the
web site, and also in the doc subdirectory in the distribution)
should get you started.  Details.html explains the basic concepts,
and api.html shows you how to read and write OpenEXR files by
presenting a number of examples.
Browsable documentation for individual classes and methods is
currently missing, but the C++ header files contain fairly long
explanatory comments.  It would be nice if there was an automatic
way to turn the header files into web pages.  (A while ago, we
tried adding markup for doxygen, but the results were not quite
what we wanted.)

Florian