wiki:devel/api/0.40/review
Last modified 6 years ago Last modified on 01/06/09 13:18:41

OpenSync API 0.40 Review

API Review process

  1. Assign API Review ticket of component opensync/XYZ
  2. Review all public API interfaces of opensync/XYZ
  3. Introduce Doxygen instrumentation for full Doxygen coverage in opensync/XYZ
  4. Move existing public API doxygen doc into header file in opensync/XYZ
  5. Fix all warnings in doxygen.log for opensync/XYZ
  6. Collect non-trival function which are missing documentation
  7. Send collection of non-trivial function to opensync-devel for shared reviewed
  8. ...

API components status

componentprivatepubliccomment
opensync/archiven/a#928n/a
opensync/clientn/a#929Completely not documented
opensync/datan/a#930n/a
opensync/dbn/a#931n/a
opensync/enginen/a#932Nearly completely not documented
opensync/formatn/a#933opensync_format_env_internals.h, opensync_filter_internals.h needs more documentation
opensync_filter doesn't export any public api but a empty public header does exist
osync_format_env_private_h needs review of the converter function names
opensync/groupn/a#934n/a
opensync/helpern/a#935n/a
opensync/ipcn/a#936serializer is not documented
opensync/mappingn/a#937n/a
opensync/mergern/a#938n/a
opensync/modulen/a#939only private API
opensync/pluginn/a#940n/a
opensync/versionn/a#941n/a
opensync/xmlformatn/a#942n/a

API guidelines

TODO

API schemas

TODO

Doxygen API Examples

Very good examples are: http://doc.trolltech.com/4.4/qpen.html http://api.kde.org/4.1-api/kdelibs-apidocs/kdecore/html/classKJob.html