storage-exapnd: Add # in the comment to make the link in the HTML 72/318272/1 accepted/tizen_9.0_unified accepted/tizen_unified accepted/tizen_unified_toolchain accepted/tizen_unified_x accepted/tizen_unified_x_asan tizen tizen_9.0 accepted/tizen/9.0/unified/20241030.233731 accepted/tizen/unified/20241001.004121 accepted/tizen/unified/20241004.041834 accepted/tizen/unified/toolchain/20241004.101821 accepted/tizen/unified/x/20241001.153944 accepted/tizen/unified/x/asan/20241014.000158 tizen_9.0_m2_release
authorUnsung <unsung.lee@samsung.com>
Thu, 26 Sep 2024 07:31:00 +0000 (16:31 +0900)
committerUnsung <unsung.lee@samsung.com>
Thu, 26 Sep 2024 07:31:03 +0000 (16:31 +0900)
Add # before writing type in the comment to make the link
in the HTML documentation.

Change-Id: Ife45abedd289ee20234d2db155c0ee451cbc06a3
Signed-off-by: Unsung <unsung.lee@samsung.com>
include/storage-expand.h

index c5f719b530bed0f96174208746fed4a52ee6b101..b081423769f99ea03a53d36e9344f597f412ba8b 100644 (file)
@@ -163,7 +163,7 @@ typedef enum {
 
 /**
  * @brief Gets the absolute path to the each directory of the given storage.
- * @details Gets absolute path among several directories defined in the storage_directory_e.
+ * @details Gets absolute path among several directories defined in the #storage_directory_e.
  * @since_tizen 2.3
  * @remarks Files saved on the internal/external storage are readable or writable by all applications.\n
  *          When an application is uninstalled, the files written by that application are not removed from the internal/external storage.\n
@@ -195,7 +195,7 @@ int storage_get_directory(int storage_id, storage_directory_e type, char **path)
 
 /**
  * @brief Gets the type (such as internal or external) of the given storage.
- * @details Gets the storage type among defined in the storage_type_e using storage_id.
+ * @details Gets the storage type among defined in the #storage_type_e using storage_id.
  * @since_tizen 2.3
  * @remarks Determines whether it is an internal or external storage using the input storage_id.
  * @param[in] storage_id The storage device
@@ -219,7 +219,7 @@ int storage_get_type(int storage_id, storage_type_e *type);
 
 /**
  * @brief Gets the current mounted state of storage corresponding to the specified id.
- * @details Gets the storage mounted state among defined in the storage_state_e using storage_id.
+ * @details Gets the storage mounted state among defined in the #storage_state_e using storage_id.
  * @since_tizen 2.3
  * @remarks Determines whether it is an internal or external storage using the input storage_id.
  * @param[in] storage_id The storage device
@@ -445,8 +445,8 @@ int storage_get_available_space(int storage_id, unsigned long long *bytes);
 
 /**
  * @brief Gets the type and the kind of external device for the given storage id.
- * @details Gets the external storage type defined in storage_type_e and kind
- *          defined in storage_dev_e using storage_id.
+ * @details Gets the external storage type defined in #storage_type_e and kind
+ *          defined in #storage_dev_e using storage_id.
  * @since_tizen 5.0
  * @remarks Works solely on external storages, not internal storages.
  *          If @a type is #STORAGE_TYPE_INTERNAL, this function returns #STORAGE_ERROR_INVALID_PARAMETER and @a dev is unchanged.