Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
ISC Open Source Projects
Kea
Commits
36338c18
Commit
36338c18
authored
Mar 20, 2015
by
Shawn Routhier
Browse files
Merge branch 'trac3735'
Merge this round of doxygen cleanup into master
parents
e49ca0e7
480971ba
Changes
15
Hide whitespace changes
Inline
Side-by-side
src/bin/d2/d2_config.h
View file @
36338c18
...
...
@@ -887,8 +887,6 @@ public:
/// Parses a configuration for the elements needed to instantiate a
/// DnsServerInfo, validates those entries, creates a DnsServerInfo instance
/// then attempts to add to a list of servers.
/// @param pos position within the configuration text (or file) of element
/// to be parsed. This is passed for error messaging.
///
/// @param server_config is the "dns_server" configuration to parse
///
...
...
src/bin/dhcp4/json_config_parser.cc
View file @
36338c18
...
...
@@ -340,6 +340,7 @@ namespace dhcp {
/// those that take format of Dhcp4/param1, Dhcp4/param2 and so forth.
///
/// @param config_id pointer to received global configuration entry
/// @param element pointer to the element to be parsed
/// @return parser for specified global DHCPv4 parameter
/// @throw NotImplemented if trying to create a parser for unknown
/// config element
...
...
src/bin/dhcp6/json_config_parser.cc
View file @
36338c18
...
...
@@ -647,6 +647,7 @@ namespace dhcp {
/// those that take format of Dhcp6/param1, Dhcp6/param2 and so forth.
///
/// @param config_id pointer to received global configuration entry
/// @param element pointer to the element to be parsed
/// @return parser for specified global DHCPv6 parameter
/// @throw NotImplemented if trying to create a parser for unknown config
/// element
...
...
src/hooks/dhcp/user_chk/pkt_send_co.cc
View file @
36338c18
// Copyright (C) 2013 Internet Systems Consortium, Inc. ("ISC")
// Copyright (C) 2013
,2015
Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
...
...
@@ -324,16 +324,16 @@ void add6Option(OptionPtr& vendor, uint8_t opt_code, std::string& opt_value) {
///
/// id_type=<id type><br/>
/// client=<id str><br/>
/// subnet=<
subnet
str><br/>
/// subnet=<
addr
str><br/>
/// registered=<is registered>
///
/// where:
///
<
id type
>
text label of the id type: "HW_ADDR" or "DUID"
///
<
id str
>
user's id formatted as either isc::dhcp::Hwaddr.toText() or
///
<
id type
>
text label of the id type: "HW_ADDR" or "DUID"
///
<
id str
>
user's id formatted as either isc::dhcp::Hwaddr.toText() or
/// isc::dhcp::DUID.toText()
///
<subnet str>
selected subnet formatted as isc::dhcp::Subnet4::toText() or
///
<addr str>
selected subnet formatted as isc::dhcp::Subnet4::toText() or
/// isc::dhcp::Subnet6::toText() as appropriate.
///
<
is registered
>
"yes" or "no"
///
<
is registered
>
"yes" or "no"
///
/// Sample IPv4 entry would like this:
///
...
...
@@ -357,7 +357,7 @@ void add6Option(OptionPtr& vendor, uint8_t opt_code, std::string& opt_value) {
///
/// @param id_type_str text label identify the id type
/// @param id_val_str text representation of the user id
/// @param
subnet
_str text representation of the selected subnet
/// @param
addr
_str text representation of the selected subnet
/// @param registered boolean indicating if the user is registered or not
void
generate_output_record
(
const
std
::
string
&
id_type_str
,
const
std
::
string
&
id_val_str
,
...
...
src/hooks/dhcp/user_chk/user.h
View file @
36338c18
// Copyright (C) 2013 Internet Systems Consortium, Inc. ("ISC")
// Copyright (C) 2013
,2015
Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
...
...
@@ -67,7 +67,7 @@ public:
/// The string is expected to contain an even number of hex digits
/// with or without colon (':') as a delimiter.
///
/// @param id
a vector of unsigned bytes containing the
id
/// @param id
_str string of hex digits representing the user's
id
///
/// @throw isc::BadValue if the string is empty, contains non
/// valid hex digits, or an odd number of hex digits.
...
...
@@ -134,8 +134,8 @@ private:
///
/// The output string has the form "<type>=<id>" where:
///
///
<type>
is the text label returned by UserId::lookupTypeStr()
///
<id>
is the output of UserId::toText() without a delimiter.
///
<type>
is the text label returned by UserId::lookupTypeStr()
///
<id>
is the output of UserId::toText() without a delimiter.
///
/// Examples:
/// HW_ADDR=0c0e0a01ff06
...
...
@@ -171,7 +171,7 @@ public:
/// Constructs a new User from a given id type and vector containing the
/// id data with an empty set of properties.
///
/// @param
user_id
Type of id contained in the id vector
/// @param
id_type
Type of id contained in the id vector
/// @param id Vector of data representing the user's id
///
/// @throw isc::BadValue if user id vector is empty.
...
...
@@ -182,8 +182,8 @@ public:
/// Constructs a new User from a given id type and string containing the
/// id data with an empty set of properties.
///
/// @param
user_id
Type of id contained in the id vector
/// @param id string of hex digits representing the user's id
/// @param
id_type
Type of id contained in the id vector
/// @param id
_str
string of hex digits representing the user's id
///
/// @throw isc::BadValue if user id string is empty or invalid
User
(
UserId
::
UserIdType
id_type
,
const
std
::
string
&
id_str
);
...
...
src/hooks/dhcp/user_chk/user_file.h
View file @
36338c18
...
...
@@ -43,8 +43,8 @@ public:
///
/// where:
///
///
<
user_type
>
text label of the id type: "HW_ADDR" or "DUID"
///
<
user_id
>
the user's id as a string of hex digits with or without
///
<
user_type
>
text label of the id type: "HW_ADDR" or "DUID"
///
<
user_id
>
the user's id as a string of hex digits with or without
/// colons (':') as a delimiter
/// (options) zero or more string elements as name-value pairs, separated by
/// commas: "opt1" : "val1", "other_opt", "77" ...
...
...
src/lib/dhcp/option_int.h
View file @
36338c18
// Copyright (C) 2012-201
4
Internet Systems Consortium, Inc. ("ISC")
// Copyright (C) 2012-201
5
Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
...
...
@@ -28,7 +28,7 @@ namespace dhcp {
template
<
typename
T
>
class
OptionInt
;
/// @defgroup option_int_
array_
defs Typedefs for OptionInt class.
/// @defgroup option_int_defs Typedefs for OptionInt class.
///
/// @brief Classes that represent options comprising an integer.
///
...
...
src/lib/dhcpsrv/d2_client_mgr.h
View file @
36338c18
...
...
@@ -220,7 +220,7 @@ public:
/// * forward will be true if S_FLAG is true
/// * reverse will be true if N_FLAG is false
///
/// @param fqdn FQDN option from which to read server (outbound) flags
/// @param fqdn
_resp
FQDN option from which to read server (outbound) flags
/// @param [out] forward bool value will be set to true if forward udpates
/// should be done, false if not.
/// @param [out] reverse bool value will be set to true if reverse udpates
...
...
src/lib/dhcpsrv/pgsql_lease_mgr.h
View file @
36338c18
// Copyright (C) 2013-201
4
Internet Systems Consortium, Inc. ("ISC")
// Copyright (C) 2013-201
5
Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
...
...
@@ -91,7 +91,7 @@ struct PsqlBindArray {
/// Adds a BINARY_FMT value to the end of the bind array using the
/// given vector as the data source.
///
/// @param
value
vector of binary bytes.
/// @param
data
vector of binary bytes.
void
add
(
const
std
::
vector
<
uint8_t
>&
data
);
/// @brief Adds a boolean value to the bind array.
...
...
src/lib/dhcpsrv/subnet.h
View file @
36338c18
...
...
@@ -337,7 +337,7 @@ public:
/// @brief Sets host reservation mode.
///
/// See @getHostReservationMode for details.
/// See @
ref
getHostReservationMode for details.
///
/// @param mode mode to be set
void
setHostReservationMode
(
HRMode
mode
)
{
...
...
src/lib/hooks/callout_manager.h
View file @
36338c18
// Copyright (C) 2013 Internet Systems Consortium, Inc. ("ISC")
// Copyright (C) 2013
,2015
Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
...
...
@@ -48,7 +48,7 @@ public:
///
/// - The list of server hooks, which is used in two ways. Firstly, when a
/// callout registers or deregisters a hook, it does so by name: the
/// @ref isc::
util
::ServerHooks object supplies the names of registered
/// @ref isc::
hooks
::ServerHooks object supplies the names of registered
/// hooks. Secondly, when the callouts associated with a hook are called by
/// the server, the server supplies the index of the relevant hook: this is
/// validated by reference to the list of hook.
...
...
@@ -87,7 +87,7 @@ public:
/// Indexes range between 1 and n (where n is the number of the libraries
/// loaded) and are assigned to libraries based on the order the libraries
/// presented to the hooks framework for loading (something that occurs in the
/// isc::
util
::HooksManager) class. However, two other indexes are recognized,
/// isc::
hooks
::HooksManager) class. However, two other indexes are recognized,
/// 0 and INT_MAX. These are used when the server itself registers callouts -
/// the server is able to register callouts that get called before any
/// user-library callouts, and ones that get called after user-library callouts.
...
...
src/lib/hooks/hooks_manager.h
View file @
36338c18
// Copyright (C) 2013 Internet Systems Consortium, Inc. ("ISC")
// Copyright (C) 2013
,2015
Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
...
...
@@ -188,7 +188,7 @@ public:
/// libraries is changed, each of the new libraries is checked before the
/// change is committed.
///
/// @param List of libraries to be validated.
/// @param
libraries
List of libraries to be validated.
///
/// @return An empty vector if all libraries validated. Otherwise it
/// holds the names of the libraries that failed validation.
...
...
src/lib/log/compiler/message.cc
View file @
36338c18
// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
// Copyright (C) 2011
,2015
Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
...
...
@@ -122,7 +122,7 @@ currentTime() {
/// \brief Create Header Sentinel
///
/// Given the name of a file, create an \#ifdef sentinel name. The name is
///
<name>_<ext>
, where <name> is the name of the file, and <ext>
///
<name>_<ext>
, where <name> is the name of the file, and <ext>
/// is the extension less the leading period. The sentinel will be upper-case.
///
/// \param file Filename object representing the file.
...
...
src/lib/util/csv_file.h
View file @
36338c18
...
...
@@ -311,7 +311,7 @@ public:
/// @brief Writes the CSV row into the file.
///
/// @param Object representing a CSV file row.
/// @param
row
Object representing a CSV file row.
///
/// @throw CSVFileError When error occurred during IO operation or if the
/// size of the row doesn't match the number of columns.
...
...
@@ -414,7 +414,7 @@ public:
/// @c validate function can set a message after successful validation
/// too. Such message could say "success", or something similar.
///
/// @param
val
_msg Error message to be set.
/// @param
read
_msg Error message to be set.
void
setReadMsg
(
const
std
::
string
&
read_msg
)
{
read_msg_
=
read_msg
;
}
...
...
@@ -466,7 +466,7 @@ protected:
/// compare that they exactly match (including order) the header read
/// from the file.
///
/// This function is called internally by @CSVFile::open. Derived classes
/// This function is called internally by @
ref
CSVFile::open. Derived classes
/// may add extra validation steps.
///
/// @todo There should be a support for optional columns (see ticket #3626).
...
...
src/lib/util/optional_value.h
View file @
36338c18
// Copyright (C) 2014 Internet Systems Consortium, Inc. ("ISC")
// Copyright (C) 2014
-2015
Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
...
...
@@ -76,8 +76,8 @@ public:
/// Creates optional value. The value defaults to "unspecified".
///
/// @param value Default explicit value.
/// @param specifie
d Value
which determines if the value is initially
// specified or not (default is false).
/// @param s
tate S
pecifie
s bool
which determines if the value is initially
//
/
specified or not (default is false).
explicit
OptionalValue
(
const
T
&
value
,
const
OptionalValueState
&
state
=
OptionalValueState
(
false
))
:
value_
(
value
),
specified_
(
state
.
specified_
)
{
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment