[TV Audio] Add missing javascript doc, fix minor lint issues
authorMarcin Wasowski <m.wasowski2@samsung.com>
Thu, 18 Dec 2014 10:58:32 +0000 (11:58 +0100)
committerLukasz Foniok <l.foniok@samsung.com>
Wed, 7 Jan 2015 12:27:27 +0000 (13:27 +0100)
Change-Id: Id57f972ec9ff8a7cf18650b1f4f4db9714aa5eb9
Signed-off-by: Marcin Wasowski <m.wasowski2@samsung.com>
src/tvaudio/tvaudio_api.js

index 85887234ea9ab8d721f89b5e9746af0b307c5004..5e226ab9478246b588b1ff4b6d2b8bb932d54c72 100644 (file)
@@ -19,7 +19,8 @@ var VOLUME_CHANGE_LISTENER = 'VolumeChangeCallback';
 
 
 /**
- * This class provides access to the API functionalities through the tizen.tvaudiocontrol interface.
+ * This class provides access to the API functionalities through
+ * the tizen.tvaudiocontrol interface.
  * @constructor
  */
 function AudioControlManager() {
@@ -52,6 +53,7 @@ AudioControlManager.prototype.setMute = function(mute) {
 
 /**
  * Gets the mute state.
+ * @return {boolean} 'true' if sound is muted else 'false'
  */
 AudioControlManager.prototype.isMute = function() {
   var ret = native.callSync('AudioControlManager_isMute');
@@ -128,8 +130,11 @@ AudioControlManager.prototype.getVolume = function() {
 
 
 /**
- * Registers a volume change callback for getting notified when TV volume has been changed.
- * @param {!function} listener The method to invoke when the volume has been changed.
+ * Registers a volume change callback for getting notified
+ * when TV volume has been changed.
+ *
+ * @param {!function} listener The method to invoke
+ *                    when the volume has been changed.
  */
 AudioControlManager.prototype.setVolumeChangeListener = function(listener) {
   var args = validator.validateArgs(arguments, [
@@ -179,7 +184,7 @@ AudioControlManager.prototype.getOutputMode = function() {
  * Plays the sound of a specific beep.
  */
 AudioControlManager.prototype.playSound = function() {
-  return undefined;
+  return;
 };