Commit 08b21520 authored by Jelte Jansen's avatar Jelte Jansen
Browse files

[trac496] changed some non-doxygen comments to doxygen

parent 06756779
...@@ -164,37 +164,37 @@ public: ...@@ -164,37 +164,37 @@ public:
/// \brief Response Code for Address Check /// \brief Response Code for Address Check
enum Category { enum Category {
SUCCESS = 0, // Packet is OK SUCCESS = 0, ///< Packet is OK
// Error categories // Error categories
ADDRESS, // Mismatching IP address ADDRESS, ///< Mismatching IP address
PORT // Mismatching port PORT ///< Mismatching port
}; };
// \brief Check IP Address /// \brief Check IP Address
// ///
// Compares the address to which the query was sent and the port it was /// Compares the address to which the query was sent and the port it was
// sent from with the address from which the query was received and the /// sent from with the address from which the query was received and the
// port it was sent to. /// port it was sent to.
// ///
// This is only required of a UDP connection - it is assumed that data that /// This is only required of a UDP connection - it is assumed that data that
// data received on a TCP stream is received from the system to which the /// data received on a TCP stream is received from the system to which the
// connection was made. /// connection was made.
// ///
// \param to Endpoint representing the address to which the query was sent. /// \param to Endpoint representing the address to which the query was sent.
// \param from Endpoint from which the response was received. /// \param from Endpoint from which the response was received.
static Category addressPortCheck(const asio::ip::udp::endpoint& to, static Category addressPortCheck(const asio::ip::udp::endpoint& to,
const asio::ip::udp::endpoint& from); const asio::ip::udp::endpoint& from);
// \brief Check QID /// \brief Check QID
// ///
// Compares the QID in the sent message with the QID in the response. /// Compares the QID in the sent message with the QID in the response.
// ///
// \param sent Message sent to the authoritative server /// \param sent Message sent to the authoritative server
// \param received Message received from the authoritative server /// \param received Message received from the authoritative server
// ///
// \return true if the QIDs match, false otherwise. /// \return true if the QIDs match, false otherwise.
static bool qidCheck(const isc::dns::Message& sent, static bool qidCheck(const isc::dns::Message& sent,
const isc::dns::Message& received) { const isc::dns::Message& received) {
return (sent.getQid() == received.getQid()); return (sent.getQid() == received.getQid());
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment