Documentation: Change |...| to `...` for code references in comments 10/N This CL includes the result of running util/update_comment_style.py over all *.h files remaining, and fixing omissions manually if necessary. Bug: 42290410 Change-Id: Ibf84738684ad759cbaa7072a2a2ce6ed6a6a6964 Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/96149 Reviewed-by: David Benjamin <davidben@google.com> Commit-Queue: Lily Chen <chlily@google.com>
diff --git a/bench/internal.h b/bench/internal.h index 70e0d9e..b304b5c 100644 --- a/bench/internal.h +++ b/bench/internal.h
@@ -29,7 +29,7 @@ // Register a function to register benchmarks after the runtime flags are // parsed. // -// It is recommended to use |BSSL_BENCH_LAZY_REGISTER| for the registration, +// It is recommended to use `BSSL_BENCH_LAZY_REGISTER` for the registration, // so that you do not have to manually wire up static initialisation with // this function. int RegisterBenchmark(void (*handle)()); @@ -61,7 +61,7 @@ // *Note* that benchmarks must be instantiated after the main function. // Otherwise, it will default to the number of available CPUs. // -// This function can only be used in the context of |BSSL_BENCH_LAZY_REGISTER|. +// This function can only be used in the context of `BSSL_BENCH_LAZY_REGISTER`. // Otherwise, the benchmark will be aborted. void SetThreads(benchmark::Benchmark *bench); @@ -69,7 +69,7 @@ // This is an interim solution, until the next `google/benchmark` release, // which contains https://github.com/google/benchmark/pull/2073. // -// This function can only be used in the context of |BSSL_BENCH_LAZY_REGISTER|. +// This function can only be used in the context of `BSSL_BENCH_LAZY_REGISTER`. // Otherwise, the benchmark will be aborted. Span<const int64_t> GetInputSizes(benchmark::Benchmark *bench);
diff --git a/tool/internal.h b/tool/internal.h index 89e1ff6..f5ec4a7 100644 --- a/tool/internal.h +++ b/tool/internal.h
@@ -36,7 +36,7 @@ // The following functions abstract between POSIX and Windows differences in // file descriptor I/O functions. -// CloseFD behaves like |close|. +// CloseFD behaves like `close`. void CloseFD(int fd); class ScopedFD { @@ -76,22 +76,22 @@ int fd_ = -1; }; -// OpenFD behaves like |open| but handles |EINTR| and works on Windows. +// OpenFD behaves like `open` but handles `EINTR` and works on Windows. ScopedFD OpenFD(const char *path, int flags); -// ReadFromFD reads up to |num| bytes from |fd| and writes the result to |out|. -// On success, it returns true and sets |*out_bytes_read| to the number of bytes -// read. Otherwise, it returns false and leaves an error in |errno|. On POSIX, -// it handles |EINTR| internally. +// ReadFromFD reads up to `num` bytes from `fd` and writes the result to `out`. +// On success, it returns true and sets `*out_bytes_read` to the number of bytes +// read. Otherwise, it returns false and leaves an error in `errno`. On POSIX, +// it handles `EINTR` internally. bool ReadFromFD(int fd, size_t *out_bytes_read, void *out, size_t num); -// WriteToFD writes up to |num| bytes from |in| to |fd|. On success, it returns -// true and sets |*out_bytes_written| to the number of bytes written. Otherwise, -// it returns false and leaves an error in |errno|. On POSIX, it handles |EINTR| +// WriteToFD writes up to `num` bytes from `in` to `fd`. On success, it returns +// true and sets `*out_bytes_written` to the number of bytes written. Otherwise, +// it returns false and leaves an error in `errno`. On POSIX, it handles `EINTR` // internally. bool WriteToFD(int fd, size_t *out_bytes_written, const void *in, size_t num); -// FDToFILE behaves like |fdopen|. +// FDToFILE behaves like `fdopen`. ScopedFILE FDToFILE(ScopedFD fd, const char *mode); enum ArgumentType { @@ -116,12 +116,12 @@ unsigned default_value, const std::map<std::string, std::string> &args); -// SplitString returns |s| split on copies of |sep|. If |sep| does not appear in -// |s|, it returns a single-element array containing |s|, even if |s| is empty. +// SplitString returns `s` split on copies of `sep`. If `sep` does not appear in +// `s`, it returns a single-element array containing `s`, even if `s` is empty. std::vector<std::string_view> SplitString(std::string_view s, std::string_view sep); -// TrimSpace returns |s| with leading and trailing spaces removed. +// TrimSpace returns `s` with leading and trailing spaces removed. std::string_view TrimSpace(std::string_view s); bool ReadAll(std::vector<uint8_t> *out, FILE *in);
diff --git a/tool/transport_common.h b/tool/transport_common.h index 66805bd..ef6470b 100644 --- a/tool/transport_common.h +++ b/tool/transport_common.h
@@ -29,8 +29,8 @@ // InitSocketLibrary calls the Windows socket init functions, if needed. bool InitSocketLibrary(); -// Connect sets |*out_sock| to be a socket connected to the destination given -// in |hostname_and_port|, which should be of the form "www.example.com:123". +// Connect sets `*out_sock` to be a socket connected to the destination given +// in `hostname_and_port`, which should be of the form "www.example.com:123". // It returns true on success and false otherwise. bool Connect(int *out_sock, const std::string &hostname_and_port); @@ -39,11 +39,11 @@ Listener() {} ~Listener(); - // Init initializes the listener to listen on |port|, which should be of the + // Init initializes the listener to listen on `port`, which should be of the // form "123". bool Init(const std::string &port); - // Accept sets |*out_sock| to be a socket connected to the listener. + // Accept sets `*out_sock` to be a socket connected to the listener. bool Accept(int *out_sock); private: @@ -69,17 +69,17 @@ bool SocketSetNonBlocking(int sock, bool is_non_blocking); // PrintSSLError prints information about the most recent SSL error to stderr. -// |ssl_err| must be the output of |SSL_get_error| and the |SSL| object must be -// connected to socket from |Connect|. +// `ssl_err` must be the output of `SSL_get_error` and the `SSL` object must be +// connected to socket from `Connect`. void PrintSSLError(FILE *file, const char *msg, int ssl_err, int ret); bool TransferData(SSL *ssl, int sock); -// DoSMTPStartTLS performs the SMTP STARTTLS mini-protocol over |sock|. It +// DoSMTPStartTLS performs the SMTP STARTTLS mini-protocol over `sock`. It // returns true on success and false otherwise. bool DoSMTPStartTLS(int sock); -// DoHTTPTunnel sends an HTTP CONNECT request over |sock|. It returns true on +// DoHTTPTunnel sends an HTTP CONNECT request over `sock`. It returns true on // success and false otherwise. bool DoHTTPTunnel(int sock, const std::string &hostname_and_port);
diff --git a/util/fipstools/acvp/modulewrapper/modulewrapper.h b/util/fipstools/acvp/modulewrapper/modulewrapper.h index e1dfd83..6f68bdb 100644 --- a/util/fipstools/acvp/modulewrapper/modulewrapper.h +++ b/util/fipstools/acvp/modulewrapper/modulewrapper.h
@@ -40,8 +40,8 @@ }; // ParseArgsFromFd returns a span of arguments, the first of which is the name -// of the requested function, from |fd|. The return values point into |buffer| -// and so must not be used after |buffer| has been freed or reused for a +// of the requested function, from `fd`. The return values point into `buffer` +// and so must not be used after `buffer` has been freed or reused for a // subsequent call. It returns an empty span on error, because std::optional // is still too new. Span<const Span<const uint8_t>> ParseArgsFromFd(int fd, RequestBuffer *buffer); @@ -50,10 +50,10 @@ bool WriteReplyToFd(int fd, const std::vector<Span<const uint8_t>> &spans); // WriteReplyToBuffer writes a reply to an internal buffer that may be flushed -// with |FlushBuffer|. +// with `FlushBuffer`. bool WriteReplyToBuffer(const std::vector<Span<const uint8_t>> &spans); -// FlushBuffer writes the buffer that |WriteReplyToBuffer| fills, to |fd|. +// FlushBuffer writes the buffer that `WriteReplyToBuffer` fills, to `fd`. bool FlushBuffer(int fd); // ReplyCallback is the type of a callback that writes a reply to an ACVP @@ -62,14 +62,14 @@ ReplyCallback; // Handler is the type of a function that handles a specific ACVP request. If -// successful it will call |write_reply| with the response arguments and return -// |write_reply|'s return value. Otherwise it will return false. The given args +// successful it will call `write_reply` with the response arguments and return +// `write_reply`'s return value. Otherwise it will return false. The given args // must not include the name at the beginning. typedef bool (*Handler)(const Span<const uint8_t> args[], ReplyCallback write_reply); -// FindHandler returns a |Handler| that can process the given arguments, or logs -// a reason and returns |nullptr| if none is found. +// FindHandler returns a `Handler` that can process the given arguments, or logs +// a reason and returns `nullptr` if none is found. Handler FindHandler(Span<const Span<const uint8_t>> args); // Run the I/O loop until error or EOF. Returns the exit code for the binary.