1 /**

     2  * Copyright (c) 2010 Sasken Communication Technologies Ltd.

     3  * All rights reserved.

     4  * This component and the accompanying materials are made available

     5  * under the terms of the "Eclipse Public License v1.0" 

     6  * which accompanies  this distribution, and is available

     7  * at the URL "http://www.eclipse.org/legal/epl-v10.html"

     8  *

     9  * Initial Contributors:

    10  * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution

    11  *

    12  * Contributors:

    13  * Manasij Roy, Nalina Hariharan

    14  * 

    15  * Description:

    16  * Intro Page

    17  *

    18  * @ref smf_high_level_design

    19  */

    20 

    21 /**

    22  * @mainpage SMF (Social Mobile Framework Interfaces)

    23  * @defgroup smf_high_level_design SMF high level design

    24  * 

    25  * Social Mobile Framework is a application level framework which allows Qt Applications

    26  * use the common web APIs to perform social web activities. 

    27  * 

    28  * Product name is "SMF"

    29  * 

    30  * For details please refer to http://developer.symbian.org/wiki/index.php/Social_Mobile_Framework

    31  * 

    32  * @section smf_interfaces SMF Interfaces

    33  * 

    34  * There are two sets of interfaces - 

    35  * 		@subsection smf_client_interfaces Client Interfaces

    36  * 				- Client Applications (e.g. Media Player, Contacts, Game) uses these APIs to access SMF. see @ref smf_client_group 

    37  * 

    38  * 		@subsection smf_plugin_interfaces Plugin Interfaces

    39  * 				- Service Providers (e.g. Facebook, Flickr, last.fm) implements these APIs to provide service to SMF - see @ref smf_plugin_group

    40  *  

    41  * Currently, @ref smf_client_interfaces and @ref smf_plugin_interfaces are defined for remote contacts, remote

    42  * image gallery and remote music services. There are common classes defined for holding data accross clients

    43  * and plugins, present in inc\common, see - @ref smf_common_group 

    44  *

    45  *	

    46  *		@section smf_client_usage Client Usage Example

    47  *		- This shows how to use the SMF client APIs in applications, e.g. Client can define suitable Models using lists returned by these APIs

    48  *				- how to fetch a list of contacts from a remote server e.g. Facebook, see @ref MyApplication::displayFriends() 	

    49  *				- how to get a @ref QContact from a SmfContacts see @ref MyApplication::showlist()

    50  *				- how to get a list of images from a remote gallery e.g. Flickr.com, see @ref MyApplication::displayGallery()

    51  *				- how to post privately to a contact see @ref MyApplication::postUpdate()

    52  *				- how to tell others about the music you are currently listen to, see @ref MyApplication::updateCurrentPlaying()    

    53  *		

    54  *		

    55  *		@section smf_dependency Dependency

    56  *		SMF uses QtMobility for mainly contacts information, see QtMobility project.    

    57    */

    58 /**

    59  * @defgroup smf_common_group Common Data Classes 

    60  */

    61 /**

    62  * @defgroup smf_client_group Client Classes 

    63  */

    64 /**

    65  * @defgroup smf_plugin_group Plugin Classes 

    66  */