diff options
| author | Mike Blumenkrantz <michael.blumenkrantz@gmail.com> | 2011-07-30 06:36:27 +0000 |
|---|---|---|
| committer | Mike Blumenkrantz <michael.blumenkrantz@gmail.com> | 2011-07-30 06:36:27 +0000 |
| commit | 37b399abbda5f2bd7a44fc80c26e0ff927514d62 (patch) | |
| tree | 6810f8009a336874e9414c63ca501cba21c230f5 | |
| parent | f03c09cf856f0356a93e3709182eb4b43218eb58 (diff) | |
| download | eet-37b399abbda5f2bd7a44fc80c26e0ff927514d62.tar.gz | |
make eet_alias docs more clear :/
SVN revision: 61920
| -rw-r--r-- | src/lib/Eet.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/lib/Eet.h b/src/lib/Eet.h index 730625c..924285d 100644 --- a/src/lib/Eet.h +++ b/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 |