2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-22 09:57:41 +00:00

[#3793] Fixed doxygen

This commit is contained in:
Francis Dupont 2025-03-19 11:40:44 +01:00
parent 646c23413c
commit a8833e16e0
5 changed files with 10 additions and 13 deletions

View File

@ -352,7 +352,7 @@ called before "subnet6_select".
- name: @b response6, type: isc::dhcp::Pkt6Ptr, direction: <b>in</b> - name: @b response6, type: isc::dhcp::Pkt6Ptr, direction: <b>in</b>
- name: @b address6, type: isc::asiolink::IOAddress, direction: <b>in</b> - name: @b address6, type: isc::asiolink::IOAddress, direction: <b>in</b>
- name: @b old_lease6, type: isc::dhcp::Lease6Ptr, direction: <b>in</b> - name: @b old_lease6, type: isc::dhcp::Lease6Ptr, direction: <b>in</b>
- name: @b new_lease6, type: isc::dhcp::Lease6Ptr, direction: <b>in<b> - name: @b new_lease6, type: isc::dhcp::Lease6Ptr, direction: <b>in</b>
- @b Description: this callout is executed when an addr-reg-inform was - @b Description: this callout is executed when an addr-reg-inform was
received and successfully processed but before the lease operation which received and successfully processed but before the lease operation which

View File

@ -334,7 +334,7 @@ public:
/// @brief Add an option. /// @brief Add an option.
/// ///
/// @note: to avoid throwing when adding multiple options /// @note: to avoid throwing when adding multiple options
/// with the same type use @ref Pkt::addOption. /// with the same type use @ref isc::dhcp::Pkt::addOption.
/// ///
/// @throw BadValue if option with that type is already present. /// @throw BadValue if option with that type is already present.
/// ///

View File

@ -75,12 +75,14 @@ public:
/// consistent. /// consistent.
/// ///
/// @param parameters The library parameters. /// @param parameters The library parameters.
/// @param [out] map The parameter map.
static void parseFile(const isc::data::ConstElementPtr& parameters, isc::db::DatabaseConnection::ParameterMap& map); static void parseFile(const isc::data::ConstElementPtr& parameters, isc::db::DatabaseConnection::ParameterMap& map);
/// @brief Parse extra parameters which are not related to backend /// @brief Parse extra parameters which are not related to backend
/// connection. /// connection.
/// ///
/// @param parameters The library parameters. /// @param parameters The library parameters.
/// @param [out] map The parameter map.
static void parseExtraParameters(const isc::data::ConstElementPtr& parameters, isc::db::DatabaseConnection::ParameterMap& map); static void parseExtraParameters(const isc::data::ConstElementPtr& parameters, isc::db::DatabaseConnection::ParameterMap& map);
/// @brief Opens the store. /// @brief Opens the store.
@ -211,9 +213,10 @@ public:
/// @brief Sets the timestamp format used for logging. /// @brief Sets the timestamp format used for logging.
/// ///
/// @param format Desired format for the string. Permissible formatting is /// @param timestamp_format Desired format for the string.
/// the one supported by strftime plus the '%Q' extra format which adds the /// Permissible formatting is the one supported by strftime plus
/// microseconds subunits. The default is: "%Y-%m-%d %H:%M:%S %Z". /// the '%Q' extra format which adds the microseconds subunits.
/// The default is: "%Y-%m-%d %H:%M:%S %Z".
void setTimestampFormat(const std::string& timestamp_format); void setTimestampFormat(const std::string& timestamp_format);
/// @brief Gets the timestamp format used for logging. /// @brief Gets the timestamp format used for logging.
@ -238,7 +241,7 @@ public:
/// ///
/// Sets the backend parameters /// Sets the backend parameters
/// ///
/// @param parameter Parameters of the backend. /// @param parameters Parameters of the backend.
virtual void setParameters(isc::db::DatabaseConnection::ParameterMap parameters) { virtual void setParameters(isc::db::DatabaseConnection::ParameterMap parameters) {
parameters_ = parameters; parameters_ = parameters;
} }

View File

@ -111,9 +111,9 @@ public:
/// @brief Gets the forensic backend manager parameters. /// @brief Gets the forensic backend manager parameters.
/// ///
/// @param parameters database parameters.
/// @param id the forensic backend manager ID /// @param id the forensic backend manager ID
/// (default value is 0 and it is used only in unit tests). /// (default value is 0 and it is used only in unit tests).
/// @return database parameters.
static isc::db::DatabaseConnection::ParameterMap getParameters(ManagerID id = 0); static isc::db::DatabaseConnection::ParameterMap getParameters(ManagerID id = 0);
/// @brief Delete a forensic backend manager. /// @brief Delete a forensic backend manager.

View File

@ -86,12 +86,6 @@ marks the staging object as "current configuration". The const pointer to the
current configuration can be accessed by calling a current configuration can be accessed by calling a
\ref isc::dhcp::CfgMgr::getCurrentCfg. \ref isc::dhcp::CfgMgr::getCurrentCfg.
The staging configuration can be discarded at any time before it is committed
by calling the \ref isc::dhcp::CfgMgr::rollback. This removes the
\ref isc::dhcp::SrvConfig object from the Configuration Manager. When
the \ref isc::dhcp::CfgMgr::getStagingCfg is called again a fresh/default
\ref isc::dhcp::SrvConfig object is returned.
The Configuration Manager stores previous configurations, i.e. configurations The Configuration Manager stores previous configurations, i.e. configurations
which occurred prior to the most current configuration. This is currently which occurred prior to the most current configuration. This is currently
unused (except for unit tests) by the daemons, but in the future this unused (except for unit tests) by the daemons, but in the future this