diff options
Diffstat (limited to 'src/libical/icalparameter.h')
| -rw-r--r-- | src/libical/icalparameter.h | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/src/libical/icalparameter.h b/src/libical/icalparameter.h index 494cc529..93cd4855 100644 --- a/src/libical/icalparameter.h +++ b/src/libical/icalparameter.h @@ -2,18 +2,10 @@ FILE: icalparam.h CREATOR: eric 20 March 1999 - (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com> + SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com> - 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/ ======================================================================*/ /** @@ -26,6 +18,7 @@ #ifndef ICALPARAMETER_H #define ICALPARAMETER_H +#include "libical_deprecated.h" #include "libical_ical_export.h" #include "icalderivedparameter.h" @@ -81,7 +74,7 @@ LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new(icalparameter_kind kind); * icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR"); * * // clone the parameter - * icalparameter *clone = icalparameter_new_clone(param); + * icalparameter *clone = icalparameter_clone(param); * * if(clone) { * // use clone ... @@ -91,8 +84,15 @@ LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new(icalparameter_kind kind); * icalparameter_free(param); * icalparameter_free(clone); * ``` + * @since 3.1.0 + */ +LIBICAL_ICAL_EXPORT icalparameter *icalparameter_clone(const icalparameter *p); + +/** + * @copydoc icalparameter_clone() + * @deprecated Use icalparameter_clone() instead */ -LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_clone(icalparameter *p); +LIBICAL_ICAL_EXPORT LIBICAL_DEPRECATED(icalparameter *icalparameter_new_clone(icalparameter *p)); /** * @brief Creates new icalparameter object from string @@ -157,9 +157,10 @@ LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_value_string(icalparam * @param parameter The icalparameter to free * * This method needs to be used on all parameter objects returned - * from any of the `_new()` methods including icalparameter_new(), icalparameter_new_clone(), - * icalparameter_new_from_string() and icalparameter_new_from_value_string(), - * when they are not needed anymore and to be released. + * from any of the `_new()` methods including icalparameter_new(), + * icalparameter_new_from_string() and icalparameter_new_from_value_string() + * and on cloned parameter objects returned by icalparameter_clone() + * when these object are not needed anymore and to be released. * * @par Usage * ```c @@ -222,9 +223,9 @@ LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string(icalparameter *parameter) * * @par Ownership * Strings returned by this method are owned by the caller, thus they need - * to be manually `free()`d after use. A version of this function which returns - * strings that do not need to be freed manually is - * icalparameter_as_ical_string(). + * to be manually `icalmemory_free_buffer()`d after use. + * A version of this function which returns strings that do not + * need to be freed manually is icalparameter_as_ical_string(). * * @par Usage * ```c @@ -233,7 +234,7 @@ LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string(icalparameter *parameter) * if(param) { * char *str = icalparameter_as_ical_string(param); * printf("%s\n", str); - * free(str); + * icalmemory_free_buffer(str); * } * * icalparameter_free(param); |