We should seriously consider documenting the Engine API and it's
expected behaviour.
This has several advantages.

1. Use that as a basis for a functional spec, which we can then write
tests to verify the implementations.

2. Helps developers to navigate and understand the code more easily.

3. Finally we need this documentation sooner than later to accompany
our releases to for the end users

4. Helps to keep both C and Java impls in sync. We should probably
modify the doc before we change the code to ensure the doc is kept

Any takers ? (Looking at Rafi :D)



Reply via email to