From: Enlightenment S. <no-...@en...> - 2011-07-30 06:36:34
|
Log: make eet_alias docs more clear :/ Author: discomfitor Date: 2011-07-29 23:36:27 -0700 (Fri, 29 Jul 2011) New Revision: 61920 Trac: http://trac.enlightenment.org/e/changeset/61920 Modified: trunk/eet/src/lib/Eet.h Modified: trunk/eet/src/lib/Eet.h =================================================================== --- trunk/eet/src/lib/Eet.h 2011-07-30 03:19:44 UTC (rev 61919) +++ trunk/eet/src/lib/Eet.h 2011-07-30 06:36:27 UTC (rev 61920) @@ -750,12 +750,13 @@ * 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 |