diff options
author | Nikias Bassen | 2023-05-05 02:43:40 +0200 |
---|---|---|
committer | Nikias Bassen | 2023-05-05 02:43:40 +0200 |
commit | 954b3e44b79396ee5352aa1c8ec1d883a4433e99 (patch) | |
tree | baa91557f84f0bd3de508b718434ba1c686837ea /include | |
parent | 4d08422860a1689ae556f822b56c8fef629ad79f (diff) | |
download | libplist-954b3e44b79396ee5352aa1c8ec1d883a4433e99.tar.gz libplist-954b3e44b79396ee5352aa1c8ec1d883a4433e99.tar.bz2 |
Update doxygen config and document undocumented macros
Diffstat (limited to 'include')
-rw-r--r-- | include/plist/plist.h | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/include/plist/plist.h b/include/plist/plist.h index 9f71777..953ecad 100644 --- a/include/plist/plist.h +++ b/include/plist/plist.h @@ -164,7 +164,7 @@ extern "C" PLIST_OPT_INDENT = 1 << 3, /**< Indent each line of output. Currently only #PLIST_FORMAT_PRINT and #PLIST_FORMAT_LIMD are supported. Use #PLIST_OPT_INDENT_BY() macro to specify the level of indentation. */ } plist_write_options_t; - /** To be used with #PLIST_OPT_INDENT. Encodes the level of indentation for OR'ing it into the #plist_write_options_t bitfield. */ + /** To be used with #PLIST_OPT_INDENT - encodes the level of indentation for OR'ing it into the #plist_write_options_t bitfield. */ #define PLIST_OPT_INDENT_BY(x) ((x & 0xFF) << 24) @@ -834,7 +834,7 @@ extern "C" * This function will look at the first bytes of the file data * to determine if it contains a binary, JSON, OpenStep, or XML plist * and tries to parse the data in the appropriate format. - * Uses #plist_read_from_data() internally. + * Uses plist_from_memory() internally. * * @param filename The name of the file to parse. * @param plist A pointer to the imported plist. @@ -944,18 +944,29 @@ extern "C" */ char plist_compare_node_value(plist_t node_l, plist_t node_r); + /** Helper macro used by PLIST_IS_* macros that will evaluate the type of a plist node. */ #define _PLIST_IS_TYPE(__plist, __plist_type) (__plist && (plist_get_node_type(__plist) == PLIST_##__plist_type)) /* Helper macros for the different plist types */ + /** Evaluates to true if the given plist node is of type PLIST_BOOLEAN */ #define PLIST_IS_BOOLEAN(__plist) _PLIST_IS_TYPE(__plist, BOOLEAN) + /** Evaluates to true if the given plist node is of type PLIST_INT */ #define PLIST_IS_INT(__plist) _PLIST_IS_TYPE(__plist, INT) + /** Evaluates to true if the given plist node is of type PLIST_REAL */ #define PLIST_IS_REAL(__plist) _PLIST_IS_TYPE(__plist, REAL) + /** Evaluates to true if the given plist node is of type PLIST_STRING */ #define PLIST_IS_STRING(__plist) _PLIST_IS_TYPE(__plist, STRING) + /** Evaluates to true if the given plist node is of type PLIST_ARRAY */ #define PLIST_IS_ARRAY(__plist) _PLIST_IS_TYPE(__plist, ARRAY) + /** Evaluates to true if the given plist node is of type PLIST_DICT */ #define PLIST_IS_DICT(__plist) _PLIST_IS_TYPE(__plist, DICT) + /** Evaluates to true if the given plist node is of type PLIST_DATE */ #define PLIST_IS_DATE(__plist) _PLIST_IS_TYPE(__plist, DATE) + /** Evaluates to true if the given plist node is of type PLIST_DATA */ #define PLIST_IS_DATA(__plist) _PLIST_IS_TYPE(__plist, DATA) + /** Evaluates to true if the given plist node is of type PLIST_KEY */ #define PLIST_IS_KEY(__plist) _PLIST_IS_TYPE(__plist, KEY) + /** Evaluates to true if the given plist node is of type PLIST_UID */ #define PLIST_IS_UID(__plist) _PLIST_IS_TYPE(__plist, UID) /* for backwards compatibility */ #define PLIST_IS_UINT PLIST_IS_INT |