Skip to content

Commit 9fe748d

Browse files
committed
cc docs: fix docs links and formatting
commit_hash:e0c3ada8a638611411d4468691cbfbeec22b212c
1 parent 18eb300 commit 9fe748d

14 files changed

Lines changed: 21 additions & 25 deletions

File tree

.mapping.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3831,8 +3831,8 @@
38313831
"scripts/docs/en/userver/grpc/middlewares_configuration.md":"taxi/uservices/userver/scripts/docs/en/userver/grpc/middlewares_configuration.md",
38323832
"scripts/docs/en/userver/grpc/middlewares_order.md":"taxi/uservices/userver/scripts/docs/en/userver/grpc/middlewares_order.md",
38333833
"scripts/docs/en/userver/grpc/middlewares_toggle.md":"taxi/uservices/userver/scripts/docs/en/userver/grpc/middlewares_toggle.md",
3834+
"scripts/docs/en/userver/grpc/server_middleware_implementation.md":"taxi/uservices/userver/scripts/docs/en/userver/grpc/server_middleware_implementation.md",
38343835
"scripts/docs/en/userver/grpc/server_middlewares.md":"taxi/uservices/userver/scripts/docs/en/userver/grpc/server_middlewares.md",
3835-
"scripts/docs/en/userver/grpc/server_middlewares_implementation.md":"taxi/uservices/userver/scripts/docs/en/userver/grpc/server_middlewares_implementation.md",
38363836
"scripts/docs/en/userver/http_server.md":"taxi/uservices/userver/scripts/docs/en/userver/http_server.md",
38373837
"scripts/docs/en/userver/http_server_middlewares.md":"taxi/uservices/userver/scripts/docs/en/userver/http_server_middlewares.md",
38383838
"scripts/docs/en/userver/intro.md":"taxi/uservices/userver/scripts/docs/en/userver/intro.md",

core/functional_tests/basic_chaos/static_config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,14 +84,14 @@ components_manager:
8484
port: 8188
8585
task_processor: main-task-processor
8686

87-
# /// logging
87+
# /// [logging]
8888
logging:
8989
fs-task-processor: fs-task-processor
9090
loggers:
9191
default:
9292
file_path: '@stderr'
9393
level: info
94-
# /// logging
94+
# /// [logging]
9595

9696
dynamic-config:
9797
updates-enabled: true

core/include/userver/components/state.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ enum class ServiceLifetimeStage {
5353
/// This stage starts after constructors for all components have completed without an exception.
5454
///
5555
/// The order of `OnAllComponentsLoaded` hooks invocations respects the order of components defined
56-
/// at @ref ServiceLifetimeStage::kComponentsLoading stage.
56+
/// at @ref ServiceLifetimeStage::kLoading stage.
5757
kOnAllComponentsLoadedIsRunning,
5858

5959
/// This stage marks that all `OnAllComponentsLoaded` hooks (as described
@@ -80,7 +80,7 @@ enum class ServiceLifetimeStage {
8080
/// @ref components::ComponentBase::OnLoadingCancelled for all constructed components.
8181
///
8282
/// The order of `OnAllComponentsAreStopping` hooks invocations respects the order of components defined
83-
/// at @ref ServiceLifetimeStage::kComponentsLoading stage (they run in the reverse-dependency order).
83+
/// at @ref ServiceLifetimeStage::kLoading stage (they run in the reverse-dependency order).
8484
kOnAllComponentsAreStoppingIsRunning,
8585

8686
/// Destructors are running for all components. This stage starts once
@@ -90,7 +90,7 @@ enum class ServiceLifetimeStage {
9090
/// after @ref ServiceLifetimeStage::kOnAllComponentsAreStoppingIsRunning for all constructed components.
9191
///
9292
/// The order of destructor invocations respects the order of components defined
93-
/// at @ref ServiceLifetimeStage::kComponentsLoading stage (they run in the reverse-dependency order).
93+
/// at @ref ServiceLifetimeStage::kLoading stage (they run in the reverse-dependency order).
9494
kStopping,
9595
};
9696

core/include/userver/engine/subprocess/process_starter.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ struct ExecOptions final {
4848
class ProcessStarter {
4949
public:
5050
/// @param task_processor will be used for executing asynchronous fork + exec.
51-
/// `main-task-processor is OK for this purpose.
51+
/// `main-task-processor` is OK for this purpose.
5252
explicit ProcessStarter(TaskProcessor& task_processor);
5353

5454
/// @param executable_path the absolute path or relative path. If `use_path` is

core/include/userver/logging/component.hpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ namespace components {
5454
///
5555
/// ### Logs output
5656
/// You can specify where logs are written in the `file_path` option:
57-
/// - Use `file_path: '@stdout'` to write your logs to standard output stream;
58-
/// - Use `file_path: '@stderr'` to write your logs to standard error stream;
59-
/// - Use `file_path: '@null'` to suppress sending of logs;
60-
/// - Use `file_path: /absolute/path/to/log/file.log` to write your logs to file. Use USR1 signal or @ref server::handlers::OnLogRotate to reopen files after log rotation;
61-
/// - Use `file_path: 'unix:/absolute/path/to/logs.sock'` to write your logs to unix socket. Socket must be created before the service starts and closed by listener after service is shut down.
57+
/// - Use <tt>file_path: '@stdout'</tt> to write your logs to standard output stream;
58+
/// - Use <tt>file_path: '@stderr'</tt> to write your logs to standard error stream;
59+
/// - Use <tt>file_path: '@null'</tt> to suppress sending of logs;
60+
/// - Use <tt>file_path: /absolute/path/to/log/file.log</tt> to write your logs to file. Use USR1 signal or @ref server::handlers::OnLogRotate to reopen files after log rotation;
61+
/// - Use <tt>file_path: 'unix:/absolute/path/to/logs.sock'</tt> to write your logs to unix socket. Socket must be created before the service starts and closed by listener after service is shut down.
6262
///
6363
/// For sending logs directly to an otlp (opentelemetry) sink, see @ref opentelemetry.
6464
///

core/include/userver/tracing/span.hpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ class Span final {
112112
///
113113
/// @return A new Span that is the root of a new Span hierarchy.
114114
/// @param name Name of a new Span
115+
/// @param source_location Implementation detail, do not touch.
115116
static Span MakeRootSpan(
116117
std::string name,
117118
const utils::impl::SourceLocation& source_location = utils::impl::SourceLocation::Current()

grpc/include/userver/ugrpc/client/middlewares/headers_propagator/component.hpp

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ namespace ugrpc::client::middlewares::headers_propagator {
1414

1515
/// @ingroup userver_components userver_base_classes
1616
///
17-
/// @brief The component for @ref ugrpc::client::middlewares::headers_propagator::Middleware.
17+
/// @brief gRPC client middleware for sending headers stored by the respective HTTP and gRPC server middlewares.
1818
///
1919
/// ## Static options:
2020
/// Name | Description | Default value
@@ -26,8 +26,7 @@ namespace ugrpc::client::middlewares::headers_propagator {
2626
class Component final : public MiddlewareFactoryComponentBase {
2727
public:
2828
/// @ingroup userver_component_names
29-
/// @brief The default name of
30-
/// ugrpc::client::middlewares::headers_propagator::Component.
29+
/// @brief The default name of ugrpc::client::middlewares::headers_propagator::Component.
3130
static constexpr std::string_view kName = "grpc-client-headers-propagator";
3231

3332
Component(const components::ComponentConfig& config, const components::ComponentContext& context);

postgresql/include/userver/storages/postgres/cluster.hpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ class Cluster {
100100
/// @param ei_settings error injection settings
101101
/// @param testsuite_tasks see @ref testsuite::TestsuiteTasks
102102
/// @param config_source see @ref dynamic_config::Source
103+
/// @param metrics metrics storage for alerts
103104
/// @param shard_number shard number
104105
/// @note When `max_connection_pool_size` is reached, and no idle connections
105106
/// available, `PoolError` is thrown for every new connection

samples/chaotic_openapi_service/testsuite/conftest.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,12 @@
55
USERVER_CONFIG_HOOKS = ['userver_config_client']
66

77

8-
# /// URL
8+
# /// [URL]
99
@pytest.fixture(scope='session')
1010
def userver_config_client(mockserver_info):
1111
def do_patch(config_yaml, config_vars):
1212
components = config_yaml['components_manager']['components']
1313
components['test-client']['base-url'] = mockserver_info.url('test')
1414

1515
return do_patch
16-
17-
18-
# /// URL
16+
# /// [URL]

scripts/docs/doxygen.conf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1160,6 +1160,7 @@ EXAMPLE_PATH = samples \
11601160
rabbitmq/functional_tests \
11611161
mysql/src \
11621162
mysql/functional_tests \
1163+
mysql/tests \
11631164
sqlite/src \
11641165
sqlite/functional_tests \
11651166
ydb/src \

0 commit comments

Comments
 (0)