From: Radoslaw Czerski <r.czerski@samsung.com>
Date: Fri, 12 Aug 2016 09:59:50 +0000 (+0200)
Subject: Documentation update.
X-Git-Tag: submit/tizen/20160817.152037^2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=1c6195def116e5c049265a51a850ef8c2eb994a6;p=profile%2Fmobile%2Fapps%2Fnative%2Findicator.git

Documentation update.

Change-Id: If6f1519715a48ac8f031b85f9ba074dd2895cd0c
Signed-off-by: Radoslaw Czerski <r.czerski@samsung.com>
---

diff --git a/inc/icon.h b/inc/icon.h
index 9db00fa..4aca7a0 100644
--- a/inc/icon.h
+++ b/inc/icon.h
@@ -63,7 +63,7 @@ extern void icon_hide(icon_s *obj);
 /**
  * @brief Sets icon animation.
  *
- * @param[in] obj icon to show
+ * @param[in] icon icon to show
  * @param[in] type animation type
  */
 extern void icon_ani_set(icon_s *icon, enum indicator_icon_ani type);
@@ -118,10 +118,10 @@ extern void icon_reset_list(void);
 
 
 /**
- * @brief Checks if non fixed icons count is greater than #PORT_NONFIXED_ICON_COUNT
+ * @brief Checks if non fixed icons count is greater than PORT_NONFIXED_ICON_COUNT
  * and shows or hides more noti icon.
  *
- * @return EINA_TRUE if icons count is greater then #PORT_NONFIXED_ICON_COUNT, EINA_FALSE otherwise
+ * @return EINA_TRUE if icons count is greater then PORT_NONFIXED_ICON_COUNT, EINA_FALSE otherwise
  *
  */
 
diff --git a/inc/main.h b/inc/main.h
index 40181c9..833171b 100644
--- a/inc/main.h
+++ b/inc/main.h
@@ -46,19 +46,21 @@
  * On the right hand side(from right to left) there are icons related to:
  * - <b>battery</b> - You can show percentage by enabling it in Settings->Battery.\n\n
  * - <b>System</b> - System related icons
- * \n\t- Sound profile - Vibrations only/Silent mode. You can change the mode in quickpanel or in Settings->Sound.
- * \n\t- Do not disturb mode - You can trigger it in Settings app.
- * \n\t- GPS - The icon will be shown when GPS module is in use.
- * \n\t- External storage - Appears when SD card is inserted.
- * \n\t- Alarm - Appears when at least one alarm is scheduled\n\n
+ * \n- Sound profile - Vibrations only/Silent mode. You can change the mode in quickpanel or in Settings->Sound.
+ * \n- Do not disturb mode - You can trigger it in Settings app.
+ * \n- GPS - The icon will be shown when GPS module is in use.
+ * \n- External storage - Appears when SD card is inserted.
+ * \n- Alarm - Appears when at least one alarm is scheduled\n\n
  * - <b>Minicontrol</b> - the icons are posted by apps that creates minicontroller
- * \n\t- Call - icon appear during call or when call is incoming or outgoing.
- * \n\t- Call Mute - Mute during call
- * \n\t- Call Speaker- Shown when speaker is on during call.
- * \n\t- Music - Shown when org.tizen.music-player/sound-player apps plays music
- * \n\t- Video - Shown when org.tizen.video-player apps plays video
- * \n\t- Voice recorder - Shown when Voice Recorder records.
- * \n\t- 3rd party - Other apps that are using Minicontrol may post icon here. Snippet explaining how to do so, will be available soon.\n\n
+ * \n- Call - icon appear during call or when call is incoming or outgoing.
+ * \n- Call Mute - Mute during call
+ * \n- Call Speaker- Shown when speaker is on during call.
+ * \n- Music - Shown when org.tizen.music-player/sound-player apps plays music
+ * \n- Video - Shown when org.tizen.video-player apps plays video
+ * \n- Voice recorder - Shown when Voice Recorder records.
+ * \n- 3rd party - Other apps that are using Minicontrol may post icon here. Snippet explaining how to do so, will be available soon.
+ * \n\n  Please check Remarks in @ref post_noti to get to know how to post icons related to minicontrollers.
+ * \n\n
  * - <b>Notification</b> - Every app is allowed to post icons here. You can find code snippets below of how to post, update or delete such icon.\n\n
  *
  * <b>Background</b>  You can change indicator background color using code snippet from below.\n\n