Skip to content

Commit e50ba7f

Browse files
committed
feat docs: fix some of the Doxygen noted issues
Tests: протестировано CI commit_hash:e8d1b24fbe9ccaeca2cae88d6bd3a5d4b0b628cd
1 parent bcbb7a6 commit e50ba7f

File tree

10 files changed

+18
-17
lines changed

10 files changed

+18
-17
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# userver [<img src="./scripts/docs/img/logo.svg" align='right' width="10%">](https://userver.tech/)
22

33
[![Ubuntu](https://github.com/userver-framework/userver/actions/workflows/ci.yml/badge.svg)](https://github.com/userver-framework/userver/actions/workflows/ci.yml)
4+
[![Fedora](https://github.com/userver-framework/userver/actions/workflows/fedora.yml/badge.svg)](https://github.com/userver-framework/userver/actions/workflows/fedora.yml)
45
[![MacOS](https://github.com/userver-framework/userver/actions/workflows/macos.yml/badge.svg)](https://github.com/userver-framework/userver/actions/workflows/macos.yml)
56
[![Alpine](https://github.com/userver-framework/userver/actions/workflows/alpine.yml/badge.svg)](https://github.com/userver-framework/userver/actions/workflows/alpine.yml)
67
[![Docker CI](https://github.com/userver-framework/userver/actions/workflows/docker.yaml/badge.svg)](https://github.com/userver-framework/userver/actions/workflows/docker.yaml)

kafka/include/userver/kafka/exceptions.hpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,18 +117,18 @@ class ParseHeadersException final : std::runtime_error {
117117
};
118118

119119
/// @brief Exception thrown when Seek* process failed.
120-
/// @ref ConsumeScope::Seek
121-
/// @ref ConsumeScope::SeekToBeginning
122-
/// @ref ConsumeScope::SeekToEnd
120+
/// @ref ConsumerScope::Seek
121+
/// @ref ConsumerScope::SeekToBeginning
122+
/// @ref ConsumerScope::SeekToEnd
123123
class SeekException final : public std::runtime_error {
124124
public:
125125
using std::runtime_error::runtime_error;
126126
};
127127

128128
/// @brief Exception thrown when Seek* arguments are invalid.
129-
/// @ref ConsumeScope::Seek
130-
/// @ref ConsumeScope::SeekToBeginning
131-
/// @ref ConsumeScope::SeekToEnd
129+
/// @ref ConsumerScope::Seek
130+
/// @ref ConsumerScope::SeekToBeginning
131+
/// @ref ConsumerScope::SeekToEnd
132132
class SeekInvalidArgumentException final : public std::invalid_argument {
133133
public:
134134
using std::invalid_argument::invalid_argument;

kafka/include/userver/kafka/rebalance_types.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ struct TopicPartitionView final {
3030
using TopicPartitionBatchView = utils::span<const TopicPartitionView>;
3131

3232
/// @brief Callback invoked when a rebalance event occurs.
33-
/// @warning The rebalance callback must be set before calling ConsumeScope::Start or after calling ConsumeScope::Stop .
33+
/// @warning The rebalance callback should be set before calling ConsumerScope::Start or after ConsumerScope::Stop.
3434
/// The callback must not throw exceptions; any thrown exceptions will be caught and logged by the consumer
3535
/// implementation.
3636
/// @note The callback is invoked after the assign or revoke event has been successfully processed.

scripts/docs/en/userver/dynamic_config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Dynamic config
22

33
For schemas of dynamic configs used by userver itself:
4-
@see @ref scripts/docs/en/schemas/dynamic_configs.md
4+
@see @ref scripts/docs/en/dynamic_configs/dynamic_configs.md
55

66
For information on how to write a service that distributes dynamic configs:
77
@see @ref scripts/docs/en/userver/tutorial/config_service.md
@@ -317,7 +317,7 @@ then you may skip this section entirely and use defaults only for testing.
317317
318318
On the other hand, if you prefer to run without a configs service, then you
319319
may want to override some of the
320-
@ref scripts/docs/en/schemas/dynamic_configs.md "built-in userver configs".
320+
@ref scripts/docs/en/dynamic_configs/dynamic_configs.md "built-in userver configs".
321321
322322
Defaults can be overridden in the config of the `dynamic-config` component:
323323
@@ -678,5 +678,5 @@ going from the lowest to the highest priority:
678678
----------
679679

680680
@htmlonly <div class="bottom-nav"> @endhtmlonly
681-
@ref rabbitmq_driver | @ref scripts/docs/en/schemas/dynamic_configs.md ⇨
681+
@ref rabbitmq_driver | @ref scripts/docs/en/dynamic_configs/dynamic_configs.md ⇨
682682
@htmlonly </div> @endhtmlonly

scripts/docs/en/userver/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,13 +121,13 @@ acquire connection + execute query <= network timeout
121121
```
122122

123123
See PostgreSQL related
124-
@ref scripts/docs/en/schemas/dynamic_configs.md for more info.
124+
@ref scripts/docs/en/dynamic_configs/dynamic_configs.md for more info.
125125

126126

127127
### PostgreSQL: Statement XXXX was canceled
128128

129129
Statement was canceled by the `statement timeout`. See PostgreSQL related
130-
@ref scripts/docs/en/schemas/dynamic_configs.md for more info.
130+
@ref scripts/docs/en/dynamic_configs/dynamic_configs.md for more info.
131131

132132

133133
### PostgreSQL: Something is slow

scripts/docs/en/userver/framework_comparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ use ❌ and ❓ respectively.
1919
| Programming model for IO-bound apps | stackful coroutines | stackful coroutines | actors | stackless coroutines | callbacks / stackless coroutines | thread pool |
2020
| Programming language to use | С++ | Go-lang | Python, JS, .Net, PHP, Java, Go | Rust | C++ | C++ |
2121
| Caching data from remote or DB | ✔️ @ref scripts/docs/en/userver/caches.md "[]" ||||| ✔️ [[]][poco-cache] |
22-
| Dynamic Config @ref fcmp1 "[1]" | ✔️ @ref scripts/docs/en/schemas/dynamic_configs.md "[]" | ✔️ [[]][gom-features] |||||
22+
| Dynamic Config @ref fcmp1 "[1]" | ✔️ @ref scripts/docs/en/dynamic_configs/dynamic_configs.md "[]" | ✔️ [[]][gom-features] |||||
2323
| Unit testing | ✔️ C++ @ref scripts/docs/en/userver/testing.md "[]" | ✔️ via Go-lang | ✔️ PHP [[]][dapr-testig] | ✔️ | ✔️ [[]][drog-testig] ||
2424
| Functional Testing @ref fcmp2 "[2]" | ✔️ @ref scripts/docs/en/userver/functional_testing.md "[]" ||[[]][dapr-testig] |[[]][actix-test] |[[]][drog-testig] ||
2525
| Async synchronization primitives | ✔️ @ref scripts/docs/en/userver/synchronization.md "[]" | ✔️ via Go-lang |[forces turn based access][dapr-actors] | ✔️ [[]][tokio-sync] || ✔️ [[]][poco-sync] |

scripts/docs/en/userver/log_level_running_service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,6 @@ This configuration disables:
255255
----------
256256

257257
@htmlonly <div class="bottom-nav"> @endhtmlonly
258-
@ref scripts/docs/en/schemas/dynamic_configs.md | @ref scripts/docs/en/userver/requests_in_flight.md ⇨
258+
@ref scripts/docs/en/dynamic_configs/dynamic_configs.md | @ref scripts/docs/en/userver/requests_in_flight.md ⇨
259259
@htmlonly </div> @endhtmlonly
260260

scripts/docs/en/userver/roadmap_and_changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Changelog news also go to the
143143
[Konstantin Goncharik](https://github.com/botanegg) for the PR!
144144
* Allow dynamic selection of response streaming. Many thanks to [Sergei Fedorov](https://github.com/zmij)
145145
for the PR!
146-
* Added support for @ref mongo::options::Hint for @ref storages::mongo::operations::Delete,
146+
* Added support for @ref storages::mongo::options::Hint for @ref storages::mongo::operations::Delete,
147147
@ref storages::mongo::bulk_ops::Update and @ref storages::mongo::bulk_ops::Delete.
148148
* @ref storages::Query now used in ClickHouse, MySQL and SQLite drivers, making it possible to directly use result of
149149
generation @ref scripts/docs/en/userver/sql_files.md "external SQL/YQL files". storages::Query::Statement() and

scripts/docs/en/userver/tutorial/postgres_service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Note the `dynamic-config.defaults` usage. In
116116
@ref scripts/docs/en/userver/tutorial/production_service.md "production ready service"
117117
those values are usually retrieved from remote server, so that they could be
118118
changed at runtime without any need to restart the service. See
119-
@ref scripts/docs/en/schemas/dynamic_configs.md for more info.
119+
@ref scripts/docs/en/dynamic_configs/dynamic_configs.md for more info.
120120

121121

122122
### int main()

scripts/docs/en/userver/tutorial/production_service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ file (if it exists).
146146
@note Dynamic configs is an essential part of a reliable service with high
147147
availability. Those could be used as an emergency switch for new
148148
functionality, selector for experiments, limits/timeouts/log-level setup,
149-
proxy setup. See @ref scripts/docs/en/schemas/dynamic_configs.md for
149+
proxy setup. See @ref scripts/docs/en/dynamic_configs/dynamic_configs.md for
150150
more info and @ref scripts/docs/en/userver/tutorial/config_service.md for
151151
insights on how to implement such service.
152152

0 commit comments

Comments
 (0)