mirror of
https://gitlab.isc.org/isc-projects/kea
synced 2025-09-01 14:35:29 +00:00
[4497] Fixed a couple doxygen issues.
This commit is contained in:
@@ -165,7 +165,7 @@ public:
|
|||||||
///
|
///
|
||||||
/// This function must be overriden in the derived classes to make
|
/// This function must be overriden in the derived classes to make
|
||||||
/// a copy of the derived type. The simplest way to do it is by
|
/// a copy of the derived type. The simplest way to do it is by
|
||||||
/// calling @ref copyInternal function with an appropriate template
|
/// calling @ref cloneInternal function with an appropriate template
|
||||||
/// parmater.
|
/// parmater.
|
||||||
///
|
///
|
||||||
/// @return Pointer to the copy of the option.
|
/// @return Pointer to the copy of the option.
|
||||||
|
@@ -229,11 +229,11 @@ protected:
|
|||||||
|
|
||||||
/// @brief Returns pointer to an option inserted by relay agent.
|
/// @brief Returns pointer to an option inserted by relay agent.
|
||||||
///
|
///
|
||||||
/// This is a variant of the @ref Pk6::getRelayOption function which
|
/// This is a variant of the @ref Pkt6::getRelayOption function which
|
||||||
/// never copies an option returned. This method should be only used by
|
/// never copies an option returned. This method should be only used by
|
||||||
/// the @ref Pkt6 class and derived classes. Any external callers should
|
/// the @ref Pkt6 class and derived classes. Any external callers should
|
||||||
/// use @ref getRelayOption which copies the option before returning it
|
/// use @ref getRelayOption which copies the option before returning it
|
||||||
/// when the @ref Pkt::copy_retrieved_option_ flag is set to true.
|
/// when the @ref Pkt::copy_retrieved_options_ flag is set to true.
|
||||||
///
|
///
|
||||||
/// @param opt_type Code of the requested option.
|
/// @param opt_type Code of the requested option.
|
||||||
/// @param relay_level Nesting level as described for
|
/// @param relay_level Nesting level as described for
|
||||||
@@ -291,7 +291,7 @@ protected:
|
|||||||
/// an option returned. This method should be only used by
|
/// an option returned. This method should be only used by
|
||||||
/// the @ref Pkt6 class and derived classes. Any external callers should
|
/// the @ref Pkt6 class and derived classes. Any external callers should
|
||||||
/// use @ref getAnyRelayOption which copies the option before returning it
|
/// use @ref getAnyRelayOption which copies the option before returning it
|
||||||
/// when the @ref Pkt::copy_retrieved_option_ flag is set to true.
|
/// when the @ref Pkt::copy_retrieved_options_ flag is set to true.
|
||||||
///
|
///
|
||||||
/// @param option_code Searched option.
|
/// @param option_code Searched option.
|
||||||
/// @param order Option search order (see @ref RelaySearchOrder).
|
/// @param order Option search order (see @ref RelaySearchOrder).
|
||||||
@@ -356,9 +356,9 @@ protected:
|
|||||||
/// of options without copying them. This method should be only used by
|
/// of options without copying them. This method should be only used by
|
||||||
/// the @ref Pkt6 class and derived classes. Any external callers should
|
/// the @ref Pkt6 class and derived classes. Any external callers should
|
||||||
/// use @ref getOptions which copies option instances before returning them
|
/// use @ref getOptions which copies option instances before returning them
|
||||||
/// when the @ref Pkt::copy_retrieved_option_ flag is set to true.
|
/// when the @ref Pkt::copy_retrieved_options_ flag is set to true.
|
||||||
///
|
///
|
||||||
/// @param option_code Option code.
|
/// @param opt_type Option code.
|
||||||
///
|
///
|
||||||
/// @return Collection of options found.
|
/// @return Collection of options found.
|
||||||
OptionCollection getNonCopiedOptions(const uint16_t opt_type) const;
|
OptionCollection getNonCopiedOptions(const uint16_t opt_type) const;
|
||||||
|
Reference in New Issue
Block a user