elua lib: add docs for elua_state_prog_name_get
authorDaniel Kolesa <d.kolesa@osg.samsung.com>
Mon, 20 Apr 2015 15:08:36 +0000 (16:08 +0100)
committerDaniel Kolesa <d.kolesa@osg.samsung.com>
Wed, 6 May 2015 14:05:22 +0000 (15:05 +0100)
src/lib/elua/Elua.h

index 7f27ba8..c2a9d12 100644 (file)
@@ -227,6 +227,7 @@ EAPI void elua_state_dirs_fill(Elua_State *es, Eina_Bool ignore_env);
  * @brief Retrieve the Elua core dir.
  *
  * @param[in] es The Elua state.
+ * @return The path.
  *
  * @ingroup Elua
  */
@@ -236,6 +237,7 @@ EAPI Eina_Stringshare *elua_state_core_dir_get(const Elua_State *es);
  * @brief Retrieve the Elua module dir.
  *
  * @param[in] es The Elua state.
+ * @return The path.
  *
  * @ingroup Elua
  */
@@ -245,11 +247,20 @@ EAPI Eina_Stringshare *elua_state_mod_dir_get(const Elua_State *es);
  * @brief Retrieve the Elua apps dir.
  *
  * @param[in] es The Elua state.
+ * @return The path.
  *
  * @ingroup Elua
  */
 EAPI Eina_Stringshare *elua_state_apps_dir_get(const Elua_State *es);
 
+/**
+ * @brief Retrieve the prog name set on state creation.
+ *
+ * @param[in] es The Elua state.
+ * @return The name.
+ *
+ * @ingroup Elua
+ */
 EAPI Eina_Stringshare *elua_state_prog_name_get(const Elua_State *es);
 
 EAPI void elua_state_include_path_add(Elua_State *es, const char *path);