diff options
Diffstat (limited to 'src/libicalss/icalcluster.h')
| -rw-r--r-- | src/libicalss/icalcluster.h | 32 |
1 files changed, 21 insertions, 11 deletions
diff --git a/src/libicalss/icalcluster.h b/src/libicalss/icalcluster.h index c5d2e960..31195bb0 100644 --- a/src/libicalss/icalcluster.h +++ b/src/libicalss/icalcluster.h @@ -2,32 +2,35 @@ FILE: icalcluster.h CREATOR: acampi 13 March 2002 - Copyright (C) 2002 Andrea Campi <a.campi@inet.it> + SPDX-FileCopyrightText: 2002 Andrea Campi <a.campi@inet.it> - This library is free software; you can redistribute it and/or modify - it under the terms of either: + SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0 - The LGPL as published by the Free Software Foundation, version - 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html - - Or: - - The Mozilla Public License Version 2.0. You may obtain a copy of - the License at https://www.mozilla.org/MPL/ ======================================================================*/ #ifndef ICALCLUSTER_H #define ICALCLUSTER_H +#include "libical_deprecated.h" #include "libical_icalss_export.h" #include "icalcomponent.h" #include "icalerror.h" typedef struct icalcluster_impl icalcluster; +/** + * @brief Create a cluster with a key/value pair. + * + * @todo Always do a deep copy. + */ LIBICAL_ICALSS_EXPORT icalcluster *icalcluster_new(const char *key, icalcomponent *data); -LIBICAL_ICALSS_EXPORT icalcluster *icalcluster_new_clone(const icalcluster *cluster); +/** + * Deeply clone an icalcluster. + * Returns a pointer to the memory for the newly cloned icalcluster. + * @since 3.1.0 +*/ +LIBICAL_ICALSS_EXPORT icalcluster *icalcluster_clone(const icalcluster *cluster); LIBICAL_ICALSS_EXPORT void icalcluster_free(icalcluster *cluster); @@ -56,4 +59,11 @@ LIBICAL_ICALSS_EXPORT icalcomponent *icalcluster_get_first_component(icalcluster LIBICAL_ICALSS_EXPORT icalcomponent *icalcluster_get_next_component(icalcluster *cluster); +/** + * @copydoc icalcluster_clone() + * @deprecated use icalcluster_clone() instead + */ +LIBICAL_ICALSS_EXPORT LIBICAL_DEPRECATED(icalcluster *icalcluster_new_clone( + const icalcluster *cluster)); + #endif /* !ICALCLUSTER_H */ |