Skip to content

Commit 6e81184

Browse files
committed
feat docs: use schemas in core for docs in more cases
Improve formatting and fix some of the doxygen warnings Tests: протестировано в CI, проверено локально что все поля отображаются и форматируются приятно для глаза (или хотя бы как было раньше) commit_hash:971d8ca5971eeac5f353a3fbe28d5cbb2197d7bd
1 parent 7dde47e commit 6e81184

File tree

56 files changed

+112
-181
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+112
-181
lines changed

clickhouse/include/userver/storages/clickhouse/component.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ namespace components {
3939
///
4040
/// @snippet samples/clickhouse_service/tests/conftest.py Clickhouse service sample - secdist
4141
///
42-
/// ## Static options of @ref components::ClickHouse :
42+
/// ## Static options of components::ClickHouse :
4343
/// @include{doc} scripts/docs/en/components_schema/clickhouse/src/storages/clickhouse/component.md
4444
///
4545
/// Options inherited from @ref components::ComponentBase :

core/include/userver/cache/caching_component_base.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ namespace components {
5151
/// * @ref USERVER_CACHES
5252
/// * @ref USERVER_DUMPS
5353
///
54-
/// ## Static options of @ref components::CachingComponentBase :
54+
/// ## Static options of components::CachingComponentBase :
5555
/// @include{doc} scripts/docs/en/components_schema/core/src/cache/caching_component_base.md
5656
///
5757
/// Options inherited from @ref components::ComponentBase :

core/include/userver/cache/lru_cache_component_base.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ yaml_config::Schema GetLruCacheComponentBaseSchema();
5151
/// ## LruCacheComponent Dynamic config
5252
/// * @ref USERVER_LRU_CACHES
5353
///
54-
/// ## Static options of @ref cache::LruCacheComponent :
54+
/// ## Static options of cache::LruCacheComponent :
5555
/// @include{doc} scripts/docs/en/components_schema/core/src/cache/lru_cache_component_base.md
5656
///
5757
/// Options inherited from @ref components::ComponentBase :

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ namespace components {
2525
/// Returned references to @ref clients::http::Client live for a lifetime of the
2626
/// component and are safe for concurrent use.
2727
///
28-
/// ## Static options of @ref components::HttpClient :
28+
/// ## Static options of components::HttpClient :
2929
/// @include{doc} scripts/docs/en/components_schema/core/src/clients/http/component.md
3030
///
3131
/// Options inherited from @ref components::ComponentBase :

core/include/userver/components/dump_configurator.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ namespace components {
1818
///
1919
/// The component must be configured in service config.
2020
///
21-
/// ## Static options of @ref components::DumpConfigurator :
21+
/// ## Static options of components::DumpConfigurator :
2222
/// @include{doc} scripts/docs/en/components_schema/core/src/components/dump_configurator.md
2323
///
2424
/// Options inherited from @ref components::ComponentBase :

core/include/userver/components/fs_cache.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ namespace components {
1515
///
1616
/// @brief Component for storing files in memory
1717
///
18-
/// ## Static options of @ref components::FsCache :
18+
/// ## Static options of components::FsCache :
1919
/// @include{doc} scripts/docs/en/components_schema/core/src/components/fs_cache.md
2020
///
2121
/// Options inherited from @ref components::ComponentBase :

core/include/userver/components/logging_configurator.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ namespace components {
2929
/// * @ref USERVER_LOG_DYNAMIC_DEBUG
3030
/// * @ref USERVER_NO_LOG_SPANS
3131
///
32-
/// ## Static options of @ref components::LoggingConfigurator :
32+
/// ## Static options of components::LoggingConfigurator :
3333
/// @include{doc} scripts/docs/en/components_schema/core/src/components/logging_configurator.md
3434
///
3535
/// Options inherited from @ref components::ComponentBase :

core/include/userver/components/process_starter.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ namespace components {
1515
///
1616
/// @brief Component for getting the engine::subprocess::ProcessStarter.
1717
///
18-
/// ## Static options of @ref components::ProcessStarter :
18+
/// ## Static options of components::ProcessStarter :
1919
/// @include{doc} scripts/docs/en/components_schema/core/src/components/process_starter.md
2020
///
2121
/// Options inherited from @ref components::ComponentBase :

core/include/userver/components/tcp_acceptor_base.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ namespace components {
2222
///
2323
/// Each accepted socket is processed in a new coroutine by ProcessSocket of the derived class.
2424
///
25-
/// ## Static options of @ref components::TcpAcceptorBase :
25+
/// ## Static options of components::TcpAcceptorBase :
2626
/// @include{doc} scripts/docs/en/components_schema/core/src/components/tcp_acceptor_base.md
2727
///
2828
/// Options inherited from @ref components::ComponentBase :

core/include/userver/congestion_control/component.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class Controller;
2424
/// * @ref USERVER_RPS_CCONTROL
2525
/// * @ref USERVER_RPS_CCONTROL_ENABLED
2626
///
27-
/// ## Static options of @ref congestion_control::Component :
27+
/// ## Static options of congestion_control::Component :
2828
/// @include{doc} scripts/docs/en/components_schema/core/src/congestion_control/component.md
2929
///
3030
/// Options inherited from @ref components::ComponentBase :

0 commit comments

Comments
 (0)