Mercurial Mercurial > oss > FCL > sf > mw > socialmobilefw / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
smf/smfdes.h
changeset 25 a180113055cb
parent 7 be09cf1f39dd 
--- a/smf/smfdes.h	Thu Sep 23 17:20:22 2010 +0530
+++ b/smf/smfdes.h	Thu Sep 23 17:43:31 2010 +0530
@@ -10,7 +10,7 @@
  * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution
  *
  * Contributors:
- * Manasij Roy, Nalina Hariharan
+ * Nalina Hariharan,Satish Kanteti, Rajat Roy
  *
  * Description:
  * Intro Page
@@ -20,7 +20,7 @@
 
 /**
  * @mainpage SMF (Social Mobile Framework Interfaces)
- * @defgroup smf_high_level_design SMF high level design
+ * @defgroup smf_high_level_design SMF Interfaces and Usage
  *
  * Social Mobile Framework is a application level framework which allows Qt Applications
  * use the common web APIs to perform social web activities.
@@ -31,44 +31,54 @@
  *
  * @section smf_interfaces SMF Interfaces
  *
- * There are two sets of interfaces -
+ * Native applications can use SMF, via Client APIs.
+ * Service Providers can provide smf plugins, via Plugin APIs.
+ * Both would use Common APIs for common data classes
+ * Service Providers can optionaliy use Credential Manager APIs
+ *
+ * Here is the list of public interfaces ( exported to /epoc32/include ) -
  * 		@subsection smf_client_interfaces Client Interfaces
  * 				- Client Applications (e.g. Media Player, Contacts, Game) uses these APIs to access SMF. see @ref smf_client_group
  *
  * 		@subsection smf_plugin_interfaces Plugin Interfaces
  * 				- Service Providers (e.g. Facebook, Flickr, last.fm) implements these APIs to provide service to SMF - see @ref smf_plugin_group
  *
- * Currently, @ref smf_client_interfaces and @ref smf_plugin_interfaces are defined for remote contacts, remote
- * image gallery and remote music services. There are common classes defined for holding data accross clients
- * and plugins, present in inc\common, see - @ref smf_common_group
+ * 		@subsection smf_common_interfaces Common Interfaces
+ * 				- Both plugins and smfclient uses these for representing data - see @ref smf_common_group
+ *
+ * 		@subsection smf_credmgr_interfaces CredMgr Interfaces
+ * 				- Credential Manager provides APIs for digital signing, storing and retrieving keys, etc - see @ref smf_credmgr_group
+ *			\ep
+ *
+ *
  *
  *
- *		@section smf_client_usage Client Usage Example
- *		- This shows how to use the SMF client APIs in applications, e.g. Client can define suitable Models using lists returned by these APIs
- *				- how to fetch a list of contacts from a remote server e.g. Facebook, see @ref MyApplication::displayFriends()
- *				- how to get a @ref QContact from a SmfContacts see @ref MyApplication::showlist()
- *				- how to get a list of images from a remote gallery e.g. Flickr.com, see @ref MyApplication::displayGallery()
- *				- how to post privately to a contact see @ref MyApplication::postUpdate()
- *				- how to tell others about the music you are currently listen to, see @ref MyApplication::updateCurrentPlaying()
- *				- how to list all the activities that has happened recently, see @ref MyApplication::getActivities() and @ref MyApplication::showActivities()
+ *	@section smf_client_usage Client Usage Example
+ *		- / example / DemoGUI / HomeView.cpp shows how to use the SMF client APIs in applications, e.g. Client can define suitable Models using lists returned by these APIs.
+ *				- how to fetch a list of contacts from a remote server e.g. Facebook, see @ref HomeView::getFriends()
+ *				- how to get a list of posts from a remote server e.g. Facebook, see @ref HomeView::getPosts()
+ *				- how to get a list of images from a remote gallery e.g. Flickr.com, see @ref HomeView::getAlbums()
+ *				- how to list all the activities that has happened recently, see @ref HomeView::getActivities()
  *
  *		@section smf_sample_plugin Sample Plugin From Service provider
- *		- This shows how to write a plugin for extending SMF service. Authentication Application also needs to be provided for these plugins.
- *				- how to create request to be sent to a remote server e.g. Flickr.com, see @ref SamplePlugin::pictures()
- *				- how to implement posting of comment on a picture to Flickr.com,  @ref SamplePlugin::postComment()
- *				- how to parse the response that arrived from Flickr.com, see @ref SamplePlugin::responseAvailable()
- *				- how to use JSON parsing from SmfPluginUtil, see @ref SamplePlugin::responseAvailable()
+ *		- This shows how to write a plugin for extending SMF service.
+ *				- how to create request to be sent to a remote server for fetching contacts e.g.Facebook.com, see @ref FBContactFetcherPlugin::friends
+ *				- how to implement the fetching of posts or comment,   @ref FBPostProviderPlugin::getPosts()
+ *				- how to parse the response that arrived from Facebook.com for fetching activities, see @ref FBActivityFetcherPlugin::responseAvailable()
+ *				- how to use JSON parsing from SmfPluginUtil, see @ref FBPostProviderPlugin::responseAvailable()
+ * 	- Authentication Application also needs to be provided for these plugins.
  *
  *		@section smf_custom_api Custom API in SMF
  *		- SMF strives to provide service API for generic "common" social operations. However this doesn't mean that developers have to
  *		use other propriatery APIs to access service specific "differentiating" features. Service Providers can provide plugins which support
- *		APIs like @ref SmfGalleryPlugin::customRequest(). A separate library would also be provided by service providers to help SMF clients use this custom
- *		API like @ref SmfGallery::customRequest().
+ *		APIs like @ref SmfGalleryPlugin::customRequest(). A separate library would also be provided by service providers to help SMF clients
+ * 	use this custom	API
  *
  *
  *
  *		@section smf_dependency Dependency
- *		- SMF uses QtMobility for mainly contacts information, see QtMobility project.
+ *		- SMF uses Qt 4.6.2 on Symbian^3  ( Nokia_Symbian3_SDK_v0.8 to be specific )
+ *		- SMF uses QtMobility 1.0 for mainly contacts information, see QtMobility project.
  *		- SMF uses QJson as utility library, courtesy Flavio Castelli , see http://gitorious.org/qjson/qjson
  *
  *		@section smf_notes Notes:
@@ -85,3 +95,6 @@
 /**
  * @defgroup smf_plugin_group Plugin Classes
  */
+/**
+ * @defgroup smf_credmgr_group CredMgr Classes
+ */
FCL/sf/mw/socialmobilefw