diff options
author | Martin Szulecki | 2009-10-28 18:49:38 +0100 |
---|---|---|
committer | Jonathan Beck | 2009-10-28 18:49:38 +0100 |
commit | 7f7ac1c257065e8dd4d40cce51ed48b09133af24 (patch) | |
tree | c5d2268eee2a8f8c048986e1a59dc00cc242af18 /include/plist/plist.h | |
parent | 6710f4bfb980dd0fe6e75e4d6cba75532cde30e8 (diff) | |
download | libplist-7f7ac1c257065e8dd4d40cce51ed48b09133af24.tar.gz libplist-7f7ac1c257065e8dd4d40cce51ed48b09133af24.tar.bz2 |
Update doxygen documentation generation to be useful.
Diffstat (limited to 'include/plist/plist.h')
-rw-r--r-- | include/plist/plist.h | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/include/plist/plist.h b/include/plist/plist.h index d3f0836..47e5df3 100644 --- a/include/plist/plist.h +++ b/include/plist/plist.h @@ -1,6 +1,7 @@ -/* - * plist.h - * Main include of libplist +/** + * @file plist/plist.h + * @brief Main include of libplist + * \internal * * Copyright (c) 2008 Jonathan Beck All Rights Reserved. * @@ -174,7 +175,7 @@ extern "C" /** * Return a copy of passed node and it's children * - * @param plist the plist to copy + * @param node the plist to copy * @return copied plist */ PLIST_API plist_t plist_copy(plist_t node); @@ -401,6 +402,7 @@ extern "C" * @param node the node * @param val a pointer to an unallocated char buffer. This function allocates the memory, * caller is responsible for freeing it. + * @param length the length of the buffer */ PLIST_API void plist_get_data_val(plist_t node, char **val, uint64_t * length); |