syncevolution/src/README.h
Patrick Ohly 980af0a3b3 better explanation what the classes do
git-svn-id: https://zeitsenke.de/svn/SyncEvolution/trunk@705 15ad00c4-1369-45f4-8270-35d70d36bdcd
2008-08-03 20:26:33 +00:00

22 lines
942 B
C

/**
* @mainpage Getting Started
*
* This documentation for SyncEvolution and the Funambol C++ Client
* API was generated automatically from the source code.
*
* While most of the classes in SyncEvolution are documented, very
* little effort was spent on organizing this information in a coherent
* way. If you are a developer who wants to write a SyncML client based
* on the SyncEvolution framework, then you should have a look at
* the following classes:
* - TrackingSyncSource is the most convenient class to derive from.
* - EvolutionSyncSource is a bit more general.
* - RegisterSyncSource adds additional sources to the framework.
*
* The following classes help with testing your derived classes:
* - RegisterSyncSourceTest is what you have to use.
* - TestEvolution uses that information.
* - ClientTest, LocalTests, SyncTests are used by TestEvolution.
*
* The FileSyncSource is a good example to get started.
*/