Skip to content

Commit 63d05a9

Browse files
committed
feat docs: fix issues noted by doxygen
Tests: протестировано локальноб на прод не влияет commit_hash:364ea8c9ac89ed522a40ea570cccfc3da4f5db18
1 parent 2ea5afb commit 63d05a9

15 files changed

Lines changed: 15 additions & 16 deletions

File tree

core/include/userver/clients/http/response.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ class Response final {
5757
enum class RaiseIncludeBody : std::uint8_t { kNo = 0, kYes = 1 };
5858

5959
/// @brief Raise an exception depending on the response status.
60-
/// The body of the response may be included in the exception depending on the @param include_body.
60+
/// The body of the response may be included in the exception depending on the \c include_body.
6161
///
6262
/// @throws HttpClientException for statuses [400; 500)
6363
/// @throws HttpServerException for statuses [500; 600)

core/include/userver/components/component_base.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ class ComponentBase : public RawComponentBase {
6060
/// active requests until this deadline (unless those requests finish earlier).
6161
/// And it might completely shutdown requests processing when the deadline is reached
6262
/// (or when no active requests left).
63-
void OnGracefulShutdown(engine::Deadline /*serving_shutdown_deadline*/) override;
63+
void OnGracefulShutdown(engine::Deadline serving_shutdown_deadline) override;
6464

6565
/// Component may use this function to stop doing work before the stop of the
6666
/// components that depend on it.

core/include/userver/engine/io/multicast_membership.hpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ class IpMreq final {
4848
int GetLeaveSocketOption() const noexcept { return (family_ == AF_INET ? IP_DROP_MEMBERSHIP : IPV6_LEAVE_GROUP); }
4949

5050
/// Returns appropriate size for setsockopt based on address family.
51-
/// @param domain Socket domain (AF_INET or AF_INET6)
5251
size_t Size() const noexcept { return (family_ == AF_INET ? sizeof(struct ip_mreqn) : sizeof(struct ipv6_mreq)); }
5352

5453
private:

core/include/userver/websocket/connection.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#pragma once
22

33
/// @file userver/websocket/connection.hpp
4-
/// @brief @copybrief server::websocket::WebSocketConnection
4+
/// @brief @copybrief websocket::WebSocketConnection
55

66
#include <memory>
77

grpc/include/userver/ugrpc/client/completion_status.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ USERVER_NAMESPACE_BEGIN
1414

1515
namespace ugrpc::client {
1616

17-
/// @ingroup userver_ugrpc
17+
/// @ingroup userver_clients
1818
///
1919
/// @brief Special completion types for gRPC client calls that don't result in a normal `grpc::Status`.
2020
///
@@ -56,7 +56,7 @@ std::string_view ToString(SpecialCaseCompletionType type);
5656
/// @brief Convert SpecialCaseCompletionType to human-readable description.
5757
std::string_view GetSpecialCaseCompletionTypeDescription(SpecialCaseCompletionType type);
5858

59-
/// @ingroup userver_ugrpc
59+
/// @ingroup userver_clients
6060
///
6161
/// @brief Result type for gRPC client call completion.
6262
///

grpc/include/userver/ugrpc/tests/simple_client_middleware_pipeline.hpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ USERVER_NAMESPACE_BEGIN
1111

1212
namespace ugrpc::tests {
1313

14+
/// @brief RPC client middleware pipeline for tests
1415
using SimpleClientMiddlewarePipeline = USERVER_NAMESPACE::middlewares::impl::SimpleMiddlewarePipeline<
1516
ugrpc::client::MiddlewareBase,
1617
ugrpc::client::ClientInfo>;

kafka/include/userver/kafka/exceptions.hpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,6 @@ class SeekInvalidArgumentException final : public std::invalid_argument {
165165
};
166166

167167
/// @brief Fatal librdkafka consumer error; polling stops and consumer is recreated.
168-
/// @ref ConsumerImpl::ThrowIfRestartRequired
169168
class ConsumerRestartRequiredException final : public std::runtime_error {
170169
public:
171170
explicit ConsumerRestartRequiredException(const std::string& message);

libraries/grpc-protovalidate/include/userver/grpc-protovalidate/client/exceptions.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#pragma once
22

3-
/// @file
3+
/// @file userver/grpc-protovalidate/client/exceptions.hpp
44
/// @brief Exceptions thrown by gRPC client validator middleware
55

66
#include <userver/grpc-protovalidate/buf_validate.hpp>
@@ -16,7 +16,7 @@ class BaseError : public ugrpc::client::RpcError {
1616
using ugrpc::client::RpcError::RpcError;
1717
};
1818

19-
/// @brief Base grpc_protovalidate error with @ref buf::validate::ValidationResult.
19+
/// @brief Base grpc_protovalidate error with `buf::validate::ValidationResult`.
2020
class MessageError : public BaseError {
2121
public:
2222
MessageError(

libraries/proto-structs/include/userver/proto-structs/io/std/chrono/time_point.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#pragma once
22

3-
/// @file userver/proto-structs/io/std/chrono/time_point_fwd.hpp
3+
/// @file userver/proto-structs/io/std/chrono/time_point.hpp
44
/// @brief Provides `std::chrono::time_point` proto struct field support.
55

66
#include <chrono>

libraries/proto-structs/include/userver/proto-structs/io/userver/decimal64/decimal.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#pragma once
22

3-
/// @file userver/proto-structs/io/userver/decimal64/decimal64.hpp
3+
/// @file userver/proto-structs/io/userver/decimal64/decimal.hpp
44
/// @brief Provides `userver::decimal64::Decimal` proto struct field support.
55

66
#include <userver/decimal64/decimal64.hpp>

0 commit comments

Comments
 (0)