Skip to content

Commit a1f7525

Browse files
committed
feat docs: fix typos and Doxygen markup
Tests: протестировано CI commit_hash:8cba4c10ea7648ad8f73d0c0899ba79d2c523822
1 parent 2a637c2 commit a1f7525

File tree

9 files changed

+12
-16
lines changed

9 files changed

+12
-16
lines changed

core/src/logging/log_test.cpp

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -100,25 +100,21 @@ TEST_F(LoggingTest, DocsData) {
100100
}
101101

102102
TEST_F(LoggingTest, DocsDataInline) {
103-
/// [Sample logging usage]
104103
LOG_TRACE("Very verbose logs, only enabled using dynamic debug logs");
105104
LOG_DEBUG("Some debug info, not logged by default in production");
106105
LOG_INFO("This is informational message");
107106
LOG_WARNING("Something strange happened");
108107
LOG_ERROR("This is unbelievable, fix me, please!");
109108
LOG_CRITICAL("The service is about to abort, bye");
110-
/// [Sample logging usage]
111109
}
112110

113111
TEST_F(LoggingTest, DocsDataInlineFormat) {
114-
/// [Sample logging usage]
115112
LOG_TRACE("Very {} logs, only enabled using dynamic debug logs", "verbose");
116113
LOG_DEBUG("Some {} info, not logged by default in production", "debug");
117114
LOG_INFO("This is {} message", "informational");
118115
LOG_WARNING("Something {} happened", "strange");
119116
LOG_ERROR("This is {}, fix me, please!", "unbelievable");
120117
LOG_CRITICAL("The service is about to {}, bye", "abort");
121-
/// [Sample logging usage]
122118

123119
// NOTE: Should not be compilable!
124120
// LOG_WARNING(fmt::format("Something {} happened", "strange"));
@@ -248,20 +244,18 @@ TEST_F(LoggingTest, LoggingNestedStructures) {
248244
}
249245
out << "]";
250246
};
251-
/// [Example Logging Nested Structures]
252247
EXPECT_EQ("Records: [{foo=1, bar=x}, {foo=2, bar=y}, ]", LoggedText());
253-
254248
ClearLog();
255-
/// [Example Logging Nested Structures]
249+
256250
LOG_INFO() << [&list](auto& out) {
257251
out << "Records: [";
258252
for (const auto& item : list) {
259253
out.Format("{{foo={}, bar={}}}, ", item.foo, item.bar);
260254
}
261255
out << "]";
262256
};
263-
/// [Example Logging Nested Structures]
264257
EXPECT_EQ("Records: [{foo=1, bar=x}, {foo=2, bar=y}, ]", LoggedText());
258+
/// [Example Logging Nested Structures]
265259
}
266260

267261
USERVER_NAMESPACE_END

libraries/grpc-protovalidate/include/userver/grpc-protovalidate/buf_validate.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/grpc-protovalidate/buf_validate.hpp
3+
/// @file
44
/// @brief Header which wraps @c buf/validate/validator.h to suppress compiler
55
/// warnings from it.
66

libraries/grpc-protovalidate/include/userver/grpc-protovalidate/client/component.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/grpc-protovalidate/client/component.hpp
3+
/// @file
44
/// @brief @copybrief grpc_protovalidate::client::ValidatorComponent
55

66
#include <userver/ugrpc/client/middlewares/base.hpp>

libraries/grpc-protovalidate/include/userver/grpc-protovalidate/client/exceptions.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/grpc-protovalidate/client/component.hpp
3+
/// @file
44
/// @brief Exceptions thrown by gRPC client validator middleware
55

66
#include <userver/grpc-protovalidate/buf_validate.hpp>

libraries/grpc-protovalidate/include/userver/grpc-protovalidate/server/component.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/grpc-protovalidate/server/component.hpp
3+
/// @file
44
/// @brief @copybrief grpc_protovalidate::server::ValidatorComponent
55

66
#include <userver/ugrpc/server/middlewares/base.hpp>

scripts/docs/doxygen.conf

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ STRIP_FROM_PATH = universal/include \
193193
ydb/include \
194194
libraries/easy/include \
195195
libraries/s3api/include \
196+
libraries/grpc-protovalidate/include \
196197
libraries/grpc-reflection/include \
197198
scripts/docs
198199

@@ -222,6 +223,7 @@ STRIP_FROM_INC_PATH = universal/include \
222223
ydb/include \
223224
libraries/easy/include \
224225
libraries/s3api/include \
226+
libraries/grpc-protovalidate/include \
225227
libraries/grpc-reflection/include \
226228
scripts/docs
227229

scripts/docs/en/userver/functional_testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ For metrics with labels, they could be retrieved in the following way:
445445
The @ref pytest_userver.metrics.Metric "Metric" python type is hashable and
446446
comparable:
447447

448-
@snippet testsuite/tests/test_metrics.py values set
448+
@snippet testsuite/tests/metrics/test_metrics.py values set
449449

450450
* C++ code: @ref samples/testsuite-support/src/metrics.cpp
451451
* C++ header: @ref samples/testsuite-support/src/metrics.hpp

scripts/docs/en/userver/roadmap_and_changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1365,7 +1365,7 @@ Detailed descriptions could be found below.
13651365
more info.
13661366
* Scripts for generating CMakeLists were simplified and cleared from internal
13671367
stuff.
1368-
* Added missing dependencies to @ref scripts/docs/en/deps/ubuntu-20.04.md and sorted all
1368+
* Added missing dependencies to Ubuntu-20.04 and sorted all
13691369
the dependencies, thanks to [Anatoly Shirokov](https://github.com/anatoly-spb)
13701370
for the PR.
13711371
* Statistics and metrics now do additional lifetime checks in debug builds to

testsuite/pytest_plugins/pytest_userver/metrics.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class Histogram:
3737
Represents the value of a HIST_RATE (a.k.a. Histogram) metric.
3838
3939
Usage example:
40-
@snippet testsuite/tests/test_metrics.py histogram
40+
@snippet testsuite/tests/metrics/test_metrics.py histogram
4141
4242
Normally obtained from MetricsSnapshot
4343
"""
@@ -73,7 +73,7 @@ class Metric:
7373
`value: int`.
7474
7575
The type is hashable and comparable:
76-
@snippet testsuite/tests/test_metrics.py values set
76+
@snippet testsuite/tests/metrics/test_metrics.py values set
7777
7878
@ingroup userver_testsuite
7979
"""

0 commit comments

Comments
 (0)