1.1 --- a/epoc32/include/hwrmvibrasdkcrkeys.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/hwrmvibrasdkcrkeys.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -1,59 +1,65 @@
     1.4  /*
     1.5 -* Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies). 
     1.6 +* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.7  * All rights reserved.
     1.8  * This component and the accompanying materials are made available
     1.9 -* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* under the terms of "Eclipse Public License v1.0"
    1.11  * which accompanies this distribution, and is available
    1.12 -* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.13 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.14  *
    1.15  * Initial Contributors:
    1.16  * Nokia Corporation - initial contribution.
    1.17  *
    1.18  * Contributors:
    1.19  *
    1.20 -* Description:  This file contains SDK central repository key definitions
    1.21 -*                for the vibra
    1.22 +* Description:
    1.23 +* The API provides the vibra related Central Repository keys. 
    1.24 +* These keys provide information on the vibra setting controlled by
    1.25 +* profiles, maximum vibrating time supported by the device and 
    1.26 +* minimum time vibra cannot be started after it was forcibly 
    1.27 +* turned off when maximum time was reached. In addition keys
    1.28 +* provide tactile feedback setting controlled by profiles and 
    1.29 +* default intensity and duration for feedback vibration.
    1.30 +* This interface relies on the Central Repository (CenRep) interface provided
    1.31 +* by Symbian. 
    1.32 +* The CenRep UID is KCRUidVibraCtrl and following keys are provided:
    1.33 +* - KVibraCtrlProfileVibraEnabled
    1.34 +* - KVibraCtrlMaxTime
    1.35 +* - KVibraMinOffTime
    1.36  *
    1.37  */
    1.38  
    1.39  
    1.40 +
    1.41 +
    1.42 +/**
    1.43 + @file 
    1.44 + @publishedAll
    1.45 + @released
    1.46 +*/
    1.47 +
    1.48  #ifndef HWRMVIBRASDKCRKEYS_H
    1.49  #define HWRMVIBRASDKCRKEYS_H
    1.50  
    1.51  #include <e32std.h>
    1.52  
    1.53 -/** 
    1.54 -* @file hwrmvibrasdkcrkeys.h
    1.55 -* 
    1.56 -* The API provides the vibra related Centrl Repository keys. 
    1.57 -* These keys provide information on the vibra setting controlled by
    1.58 -* Profiles, maximum vibrating time supported by the device and 
    1.59 -* minimum time vibra cannot be started after it was forcibly 
    1.60 -* turned off when maximum time was reached. In addition keys
    1.61 -* provide tactile feedback setting controlled by profiles and 
    1.62 -* default intensity and duration for feedback vibration.
    1.63 -*
    1.64 -* This interface relies on the Central Repository (CenRep) interface provided
    1.65 -* by Symbian. 
    1.66 -*
    1.67 -* The CenRep UID is #KCRUidVibraCtrl and following keys are provided:
    1.68 -* - #KVibraCtrlProfileVibraEnabled
    1.69 -* - #KVibraCtrlMaxTime
    1.70 -* - #KVibraMinOffTime
    1.71 -*/
    1.72 -
    1.73  /**
    1.74  * CenRep UID for all vibra related settings keys provided by this API.
    1.75 +*
    1.76 +* @publishedAll
    1.77 +* @released
    1.78  */
    1.79  const TUid KCRUidVibraCtrl = {0x10200C8B};
    1.80  
    1.81  /**
    1.82 -* Vibra setting controlled by Profiles. 
    1.83 +* Vibra setting controlled by profiles. 
    1.84  * 
    1.85  * Possible integer values:
    1.86  *
    1.87  * 0 = Vibra is off in profile (default value) <br>
    1.88  * 1 = Vibra is on in profile <br>
    1.89 +*
    1.90 +* @publishedAll
    1.91 +* @released
    1.92  */
    1.93  const TUint32 KVibraCtrlProfileVibraEnabled     = 0x00000001;
    1.94  
    1.95 @@ -67,6 +73,9 @@
    1.96  * Value is read-only.
    1.97  *
    1.98  * Default value: 10000.
    1.99 +*
   1.100 +* @publishedAll
   1.101 +* @released
   1.102  */
   1.103  const TUint32 KVibraCtrlMaxTime                 = 0x00000002;
   1.104  
   1.105 @@ -81,6 +90,9 @@
   1.106  * Value is read-only.
   1.107  *
   1.108  * Default value: 0
   1.109 +*
   1.110 +* @publishedAll
   1.111 +* @released
   1.112  */
   1.113  const TUint32 KVibraMinOffTime                  = 0x00000003;
   1.114  
   1.115 @@ -91,6 +103,9 @@
   1.116  *
   1.117  * 0 = Tactile feedback is off in profile (default value) <br>
   1.118  * 1 = Tactile feedback is on in profile <br>
   1.119 +*
   1.120 +* @publishedAll
   1.121 +* @released
   1.122  */
   1.123  const TUint32 KVibraCtrlProfileFeedbackEnabled  = 0x00000004;
   1.124  
   1.125 @@ -102,6 +117,9 @@
   1.126  * Value is read-only.
   1.127  *
   1.128  * Default value: 100
   1.129 +*
   1.130 +* @publishedAll
   1.131 +* @released
   1.132  */
   1.133  const TUint32 KVibraCtrlFeedbackIntensity       = 0x00000005;
   1.134  
   1.135 @@ -113,10 +131,14 @@
   1.136  * Value is read-only.
   1.137  *
   1.138  * Default value: 20
   1.139 +*
   1.140 +* @publishedAll
   1.141 +* @released
   1.142  */
   1.143  const TUint32 KVibraCtrlFeedbackDuration        = 0x00000006;
   1.144  
   1.145  
   1.146 +
   1.147  #endif  // HWRMVIBRASDKCRKEYS_H
   1.148              
   1.149  // End of File