1
0
mirror of https://github.com/mfontanini/libtins synced 2026-01-23 02:35:57 +01:00

Replace "wether" with "whether" on doc strings

This commit is contained in:
Matias Fontanini
2016-01-31 20:45:30 -08:00
parent fb4e5086fd
commit 88d8f99676
28 changed files with 46 additions and 46 deletions

View File

@@ -298,7 +298,7 @@ public:
const hwaddress_type& hw_snd = hwaddress_type());
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -299,7 +299,7 @@ public:
void vend(const vend_type& newvend_);
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* This returns true if the xid field is equal.
*

View File

@@ -859,7 +859,7 @@ public:
uint32_t header_size() const;
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -939,7 +939,7 @@ public:
static std::string decode_domain_name(const std::string& domain_name);
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -108,7 +108,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -226,7 +226,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -361,7 +361,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -497,7 +497,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -633,7 +633,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/

View File

@@ -140,7 +140,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -240,7 +240,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/

View File

@@ -475,7 +475,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/

View File

@@ -137,7 +137,7 @@ public:
uint32_t header_size() const;
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/

View File

@@ -82,7 +82,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -214,7 +214,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -276,7 +276,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -338,7 +338,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -400,7 +400,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -460,7 +460,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -591,7 +591,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -740,7 +740,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/

View File

@@ -234,7 +234,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -345,7 +345,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/

View File

@@ -1212,7 +1212,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/

View File

@@ -85,7 +85,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -219,7 +219,7 @@ public:
PDUType pdu_type() const { return pdu_flag; }
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/

View File

@@ -181,7 +181,7 @@ public:
void append_padding(bool value);
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -153,7 +153,7 @@ public:
#endif // !_WIN32 || HAVE_PACKET_SENDER_PCAP_SENDPACKET
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -354,7 +354,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/
@@ -755,7 +755,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
* \param flag The flag to match
* \sa PDU::matches_flag
*/

View File

@@ -158,7 +158,7 @@ public:
void send(PacketSender& sender, const NetworkInterface& iface);
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -238,7 +238,7 @@ public:
/**
* \brief Sets parameter problem flag for this PDU.
*
* \param set_pointer Indicates wether a pointer to the bad octet
* \param set_pointer Indicates whether a pointer to the bad octet
* is provided.
* \param bad_octet Identifies the octet in which the error was
* detected. If set_pointer == false, it is ignored.
@@ -396,7 +396,7 @@ public:
uint32_t trailer_size() const;
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -1084,7 +1084,7 @@ public:
void use_length_field(bool value);
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -685,7 +685,7 @@ public:
void send(PacketSender& sender, const NetworkInterface &);
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -256,7 +256,7 @@ public:
uint32_t header_size() const;
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -95,7 +95,7 @@ public:
}
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -393,9 +393,9 @@ public:
virtual PDU* recv_response(PacketSender& sender, const NetworkInterface& iface);
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* This method must check wether the buffer pointed by ptr is a valid
* This method must check whether the buffer pointed by ptr is a valid
* response for this PDU. If it is valid, then it might want to propagate
* the call to the next PDU. Note that in some cases, such as ICMP
* Host Unreachable, there is no need to ask the next layer for matching.
@@ -407,7 +407,7 @@ public:
}
/**
* \brief Check wether this PDU matches the specified flag.
* \brief Check whether this PDU matches the specified flag.
*
* This method should be reimplemented in PDU classes which have
* subclasses, and try to match the given PDU to each of its parent

View File

@@ -369,7 +369,7 @@ public:
return (PresentFlags)Endian::le_to_host(radio_.flags_32);
}
/** \brief Check wether ptr points to a valid response for this PDU.
/** \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -166,7 +166,7 @@ public:
}
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* This always returns true, since we don't know what this
* RawPDU is holding.

View File

@@ -315,7 +315,7 @@ public:
* constructor.
* \param device The device which will be sniffed.
* \param max_packet_size The maximum packet size to be read.
* \param promisc bool indicating wether to put the interface in promiscuous mode.(optional)
* \param promisc bool indicating whether to put the interface in promiscuous mode.(optional)
* \param filter A capture filter to be used on the sniffing session.(optional);
* \param rfmon Indicates if the interface should be put in monitor mode.(optional);
*/

View File

@@ -511,7 +511,7 @@ public:
uint32_t header_size() const;
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* \sa PDU::matches_response
* \param ptr The pointer to the buffer.

View File

@@ -144,7 +144,7 @@ public:
void length(uint16_t new_len);
/**
* \brief Check wether ptr points to a valid response for this PDU.
* \brief Check whether ptr points to a valid response for this PDU.
*
* This compares the source and destination ports in the provided
* response with those stored in this PDU.

View File

@@ -156,7 +156,7 @@ TINS_API std::set<std::string> network_interfaces();
* \param gw_addr This parameter will contain the gateway's IP
* address in case it is found.
*
* \return bool indicating wether the lookup was successfull.
* \return bool indicating whether the lookup was successfull.
*/
TINS_API bool gateway_from_ip(IPv4Address ip, IPv4Address& gw_addr);