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

component	private	public	comment
opensync/archive	n/a	#928	n/a
opensync/client	n/a	#929	Completely not documented
opensync/data	n/a	#930	n/a
opensync/db	n/a	#931	n/a
opensync/engine	n/a	#932	Nearly completely not documented
opensync/format	n/a	#933	opensync_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/group	n/a	#934	n/a
opensync/helper	n/a	#935	n/a
opensync/ipc	n/a	#936	serializer is not documented
opensync/mapping	n/a	#937	n/a
opensync/merger	n/a	#938	n/a
opensync/module	n/a	#939	only private API
opensync/plugin	n/a	#940	n/a
opensync/version	n/a	#941	n/a
opensync/xmlformat	n/a	#942	n/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