From dcc3d630e04dac127f7c8d799faba773dacfb22e Mon Sep 17 00:00:00 2001 From: Mike Blumenkrantz Date: Sat, 30 Jul 2011 06:36:27 +0000 Subject: [PATCH] make eet_alias docs more clear :/ SVN revision: 61920 --- legacy/eet/src/lib/Eet.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/legacy/eet/src/lib/Eet.h b/legacy/eet/src/lib/Eet.h index 730625c71a..924285d46f 100644 --- a/legacy/eet/src/lib/Eet.h +++ b/legacy/eet/src/lib/Eet.h @@ -750,12 +750,13 @@ eet_delete(Eet_File *ef, * Alias a specific section to another one. Destination may exist or not, * no check are done. * @param ef A valid eet file handle opened for writing. - * @param name Name of the entry. eg: "/base/file_i_want". - * @param destination Destination of the alias. eg: "/base/the_real_stuff_i_want". + * @param name Name of the new entry. eg: "/base/file_i_want". + * @param destination Actual source of the aliased entry eg: "/base/the_real_stuff_i_want". * @param compress Compression flags (1 == compress, 0 = don't compress). * @return EINA_TRUE on success, EINA_FALSE on failure. * * Name and Destination must not be NULL, otherwise EINA_FALSE will be returned. + * The equivalent of this would be calling 'ln -s destination name' * * @since 1.3.3 * @ingroup Eet_File_Group