Skip to content

Commit

Permalink
Fix some Typos
Browse files Browse the repository at this point in the history
  • Loading branch information
jens-diewald committed Jul 30, 2024
1 parent 6391e42 commit a7935f2
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion examples/echo_client.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ int main(int argc, char* argv[]) {
auto certificate = wintls::x509_to_cert_context(net::buffer(x509_certificate),
wintls::file_format::pem);

// Add certifcate as a trusted certifcate authority and verify it on handshake
// Add certificate as a trusted certificate authority and verify it on handshake
ctx.add_certificate_authority(certificate.get());
ctx.verify_server_certificate(true);

Expand Down
2 changes: 1 addition & 1 deletion examples/echo_server.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ class server {
~server() {
// Remove the imported private key. Most real applications
// probably only want to import the key once and most likely not
// in the server code. This is just for demonstration purposesq.
// in the server code. This is just for demonstration purposes.
wintls::error_code ec;
wintls::delete_private_key(private_key_name_, ec);
}
Expand Down
4 changes: 2 additions & 2 deletions include/wintls/certificate.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ inline void delete_private_key(const std::string& name, wintls::error_code& ec)
* @endverbatim
*
* This function will associate the named key with the given
* certficate in order for it be used by eg. @ref context::use_certificate.
* certificate in order for it be used by eg. @ref context::use_certificate.
*
* @note No check is done to ensure the key exists. Associating a non
* existing or non accessible key will result in unexpected behavior
Expand Down Expand Up @@ -260,7 +260,7 @@ inline void assign_private_key(const CERT_CONTEXT* cert, const std::string& name
* @endverbatim
*
* This function will associate the named key with the given
* certficate in order for it be used by eg. @ref context::use_certificate.
* certificate in order for it be used by eg. @ref context::use_certificate.
*
* @note No check is done to ensure the key exists. Associating a non
* existing or non accessible key will result in unexpected behavior
Expand Down
12 changes: 6 additions & 6 deletions include/wintls/context.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class context {
* This function is used to add one trusted certification authority
* to the contexts certificate store used for certificate validation
*
* @param cert The certficate to add to the certificate store
* @param cert The certificate to add to the certificate store
*
* @throws wintls::system_error Thrown on failure.
*/
Expand All @@ -50,7 +50,7 @@ class context {
* This function is used to add one trusted certification authority
* to the contexts certificate store used for certificate validation
*
* @param cert The certficate to add to the certificate store
* @param cert The certificate to add to the certificate store
*
* @param ec Set to indicate what error occurred, if any.
*/
Expand All @@ -77,8 +77,8 @@ class context {

/** Use the default operating system certificates
*
* This function may be used to verify the server certficates
* against the certficates installed in the operating system when
* This function may be used to verify the server certificates
* against the certificates installed in the operating system when
* performing handshakes as a client.
*
* It is still possible to add additional certificates for
Expand All @@ -94,7 +94,7 @@ class context {

/** Set the certificate to use when operating as a server
*
* This function sets the certficate to use when using a @ref stream
* This function sets the certificate to use when using a @ref stream
* as server.
*
* @param cert The private certificate the @ref stream will use for
Expand All @@ -113,7 +113,7 @@ class context {

/** Set the certificate to use when operating as a server
*
* This function sets the certficate to use when using a @ref stream
* This function sets the certificate to use when using a @ref stream
* as server.
*
* @param cert The private certificate the @ref stream will use for
Expand Down
6 changes: 3 additions & 3 deletions include/wintls/stream.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ class stream {
* @code
* void handler(
* const wintls::error_code& error, // Result of operation.
* std::size_t bytes_transferred // Number of bytes read.
* std::size_t bytes_transferred // Number of bytes read.
* ); @endcode
*
* @note The `async_read_some` operation may not read all of the
Expand Down Expand Up @@ -402,7 +402,7 @@ class stream {
* @code
* void handler(
* const wintls::error_code& error, // Result of operation.
* std::size_t bytes_transferred // Number of bytes written.
* std::size_t bytes_transferred // Number of bytes written.
* );
* @endcode
*
Expand Down Expand Up @@ -457,7 +457,7 @@ class stream {
* This function is used to asynchronously shut down TLS on the
* stream. This function call always returns immediately.
*
* @param handler The handler to be called when the handshake
* @param handler The handler to be called when the shutdown
* operation completes. Copies will be made of the handler as
* required. The equivalent function signature of the handler must
* be:
Expand Down

0 comments on commit a7935f2

Please sign in to comment.