forked from enlightenment/efl
eina_file: move doc block about eina_file_path_join from inline to file.h
This commit is contained in:
parent
7ebeec3dec
commit
214883f099
|
@ -709,6 +709,25 @@ EAPI Eina_Iterator *eina_file_map_lines(Eina_File *file);
|
||||||
*/
|
*/
|
||||||
EAPI Eina_Bool eina_file_map_faulted(Eina_File *file, void *map);
|
EAPI Eina_Bool eina_file_map_faulted(Eina_File *file, void *map);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Join two paths of known length.
|
||||||
|
*
|
||||||
|
* @param dst The buffer to store the result.
|
||||||
|
* @param size Size (in byte) of the buffer.
|
||||||
|
* @param a First path to use.
|
||||||
|
* @param a_len length of @p a.
|
||||||
|
* @param b Second path to use.
|
||||||
|
* @param b_len length of @p b.
|
||||||
|
* @return The number of characters printed.
|
||||||
|
*
|
||||||
|
* This function is similar to eina_str_join_len(), but the separator
|
||||||
|
* is '\' on Windows and '/' otherwise.
|
||||||
|
*
|
||||||
|
* @see eina_str_join_len()
|
||||||
|
* @see eina_file_path_join()
|
||||||
|
*
|
||||||
|
* @since 1.16
|
||||||
|
*/
|
||||||
static inline size_t eina_file_path_join_len(char *dst,
|
static inline size_t eina_file_path_join_len(char *dst,
|
||||||
size_t size,
|
size_t size,
|
||||||
const char *a,
|
const char *a,
|
||||||
|
@ -716,6 +735,23 @@ static inline size_t eina_file_path_join_len(char *dst,
|
||||||
const char *b,
|
const char *b,
|
||||||
size_t b_len);
|
size_t b_len);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Join two paths of known length.
|
||||||
|
*
|
||||||
|
* @param dst The buffer to store the result.
|
||||||
|
* @param size Size (in byte) of the buffer.
|
||||||
|
* @param a First string to use.
|
||||||
|
* @param b Second string to use.
|
||||||
|
* @return The number of characters printed.
|
||||||
|
*
|
||||||
|
* This function is similar to eina_file_path_join_len(), but will compute
|
||||||
|
* the length of @p a and @p b using strlen(). The path separator is
|
||||||
|
* '\' on Windows and '/' otherwise.
|
||||||
|
*
|
||||||
|
* @see eina_file_path_join_len()
|
||||||
|
*
|
||||||
|
* @since 1.16
|
||||||
|
*/
|
||||||
static inline size_t eina_file_path_join(char *dst,
|
static inline size_t eina_file_path_join(char *dst,
|
||||||
size_t size,
|
size_t size,
|
||||||
const char *a,
|
const char *a,
|
||||||
|
|
|
@ -19,31 +19,6 @@
|
||||||
#ifndef EINA_FILE_INLINE_H_
|
#ifndef EINA_FILE_INLINE_H_
|
||||||
#define EINA_FILE_INLINE_H_
|
#define EINA_FILE_INLINE_H_
|
||||||
|
|
||||||
/**
|
|
||||||
* @addtogroup Eina_File_Group File
|
|
||||||
*
|
|
||||||
* @{
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Join two paths of known length.
|
|
||||||
*
|
|
||||||
* @param dst The buffer to store the result.
|
|
||||||
* @param size Size (in byte) of the buffer.
|
|
||||||
* @param a First path to use.
|
|
||||||
* @param a_len length of @p a.
|
|
||||||
* @param b Second path to use.
|
|
||||||
* @param b_len length of @p b.
|
|
||||||
* @return The number of characters printed.
|
|
||||||
*
|
|
||||||
* This function is similar to eina_str_join_len(), but the separator
|
|
||||||
* is '\' on Windows and '/' otherwise.
|
|
||||||
*
|
|
||||||
* @see eina_str_join_len()
|
|
||||||
* @see eina_file_path_join()
|
|
||||||
*
|
|
||||||
* @since 1.16
|
|
||||||
*/
|
|
||||||
static inline size_t
|
static inline size_t
|
||||||
eina_file_path_join_len(char *dst,
|
eina_file_path_join_len(char *dst,
|
||||||
size_t size,
|
size_t size,
|
||||||
|
@ -55,23 +30,6 @@ eina_file_path_join_len(char *dst,
|
||||||
return eina_str_join_len(dst, size, EINA_PATH_SEP_C, a, a_len, b, b_len);
|
return eina_str_join_len(dst, size, EINA_PATH_SEP_C, a, a_len, b, b_len);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Join two paths of known length.
|
|
||||||
*
|
|
||||||
* @param dst The buffer to store the result.
|
|
||||||
* @param size Size (in byte) of the buffer.
|
|
||||||
* @param a First string to use.
|
|
||||||
* @param b Second string to use.
|
|
||||||
* @return The number of characters printed.
|
|
||||||
*
|
|
||||||
* This function is similar to eina_file_path_join_len(), but will compute
|
|
||||||
* the length of @p a and @p b using strlen(). The path separator is
|
|
||||||
* '\' on Windows and '/' otherwise.
|
|
||||||
*
|
|
||||||
* @see eina_file_path_join_len()
|
|
||||||
*
|
|
||||||
* @since 1.16
|
|
||||||
*/
|
|
||||||
static inline size_t
|
static inline size_t
|
||||||
eina_file_path_join(char *dst, size_t size, const char *a, const char *b)
|
eina_file_path_join(char *dst, size_t size, const char *a, const char *b)
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in New Issue