[Speex-dev] Help for documentation

Jean-Marc Valin Jean-Marc.Valin at USherbrooke.ca
Thu Jun 23 23:05:47 PDT 2005


As some probably noticed, there are still many things missing in the
Speex documentation. Given the limited amount of time I have right now,
help would be really appreciated. I'm sure there are many people on this
list that have successfully used Speex so far and that would be able to
contribute to one part or another. Here are things that could be done:

- Manual
  * Provide mode detailed explanation about encoding and decoding
  * Improve documentation for echo canceller and preprocessor
  * Document jitter buffer
  * Complete documentation of the internals (requires more knowledge of

  * Improve Doxygen comments in the header files

  * Read through the mailing list archive and use answers there to
extend the FAQ

The last point actually requires limited knowledge about Speex, so it
may be a good way to familiarize with Speex. Any takers?


More information about the Speex-dev mailing list