Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat docs: fix some issues noted by Doxygen #885

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions clickhouse/include/userver/storages/clickhouse.hpp
Original file line number Diff line number Diff line change
@@ -18,13 +18,13 @@
/// components::ClickHouse. The uClickHouse driver is asynchronous, it suspends
/// current coroutine for carrying out network I/O.
///
/// @section feature Features
/// @section clickhouse_feature Features
/// - Connection pooling;
/// - Variadic template query parameter passing;
/// - Query result extraction to C++ types;
/// - Mapping C++ types to native ClickHouse types.
///
/// @section info More information
/// @section clickhouse_info More information
/// - For configuration see components::ClickHouse
/// - For cluster operations see storages::clickhouse::Cluster
/// - For mapping C++ types to Clickhouse types see @ref clickhouse_io
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once

/// @file userver/server/handlers/auth/digest/digest_checker_settings_component.hpp
/// @file userver/server/handlers/auth/digest/auth_checker_settings_component.hpp
/// @brief @copybrief server::handlers::auth::digest::AuthCheckerSettingsComponent

#include <chrono>
2 changes: 1 addition & 1 deletion grpc/include/userver/ugrpc/client/middlewares/base.hpp
Original file line number Diff line number Diff line change
@@ -96,7 +96,7 @@ class MiddlewareBase {
MiddlewareBase();
};

/// @ingroup userver_components userver_base_classes
/// @ingroup userver_base_classes
///
/// @brief Factory that creates specific client middlewares for clients.
using MiddlewareFactoryComponentBase =
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ namespace ugrpc::server::middlewares::baggage {

// clang-format off

/// @ingroup userver_components userver_base_classes
/// @ingroup userver_base_classes
///
/// @brief Component for gRPC server baggage
///
2 changes: 1 addition & 1 deletion grpc/include/userver/ugrpc/server/middlewares/base.hpp
Original file line number Diff line number Diff line change
@@ -89,7 +89,7 @@ class MiddlewareBase {
virtual void CallResponseHook(const MiddlewareCallContext& context, google::protobuf::Message& response);
};

/// @ingroup userver_components userver_base_classes
/// @ingroup userver_base_classes
///
/// @brief Factory that creates specific server middlewares for services.
using MiddlewareFactoryComponentBase =
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ namespace ugrpc::server::middlewares::deadline_propagation {

// clang-format off

/// @ingroup userver_components userver_base_classes
/// @ingroup userver_base_classes
///
/// @brief Component for gRPC server deadline propagation
/// @see @ref scripts/docs/en/userver/deadline_propagation.md
4 changes: 2 additions & 2 deletions rabbitmq/include/userver/rabbitmq.hpp
Original file line number Diff line number Diff line change
@@ -23,15 +23,15 @@
/// components::RabbitMQ. The uRabbitMQ driver is asynchronous, it suspends
/// current coroutine for carrying out network I/O.
///
/// @section feature Features
/// @section rabbitmq_feature Features
/// - Publishing messages;
/// - Consuming messages;
/// - Creating Exchanges, Queues and Bindings;
/// - Transport level security;
/// - Connections pooling;
/// - End-to-end logging for messages in publish->consume chain.
///
/// @section info More information
/// @section rabbitmq_info More information
/// - For configuration see components::RabbitMQ
/// - For cluster operations see urabbitmq::Client, urabbitmq::AdminChannel,
/// urabbitmq::Channel, urabbitmq::ReliableChannel
3 changes: 1 addition & 2 deletions scripts/docs/doxygen.conf
Original file line number Diff line number Diff line change
@@ -982,7 +982,6 @@ INPUT = CONTRIBUTING.md \
universal/utest/include \
core/include \
core/utest/include \
chaotic/include \
mongo/include \
postgresql/include \
redis/include \
@@ -996,7 +995,6 @@ INPUT = CONTRIBUTING.md \
ydb/include \
otlp/include \
testsuite/pytest_plugins/ \
docker-compose.yml \
libraries \
scripts/docker/

@@ -2569,6 +2567,7 @@ INCLUDE_FILE_PATTERNS =

PREDEFINED = __attribute__(x)= \
DOXYGEN \
USERVER_IMPL_HAS_THREE_WAY_COMPARISON \
"USERVER_NAMESPACE=" \
"USERVER_NAMESPACE_BEGIN=" \
"USERVER_NAMESPACE_END="
2 changes: 0 additions & 2 deletions scripts/docs/en/userver/functional_testing.md
Original file line number Diff line number Diff line change
@@ -513,7 +513,6 @@ For per-daemon fixtures see @ref pytest_userver.plugins.service.daemon_scoped_ma
@htmlonly </div> @endhtmlonly

@example cmake/UserverTestsuite.cmake
@example samples/http_caching/tests/conftest.py
@example samples/testsuite-support/src/logcapture.cpp
@example samples/testsuite-support/src/metrics.cpp
@example samples/testsuite-support/src/metrics.hpp
@@ -525,4 +524,3 @@ For per-daemon fixtures see @ref pytest_userver.plugins.service.daemon_scoped_ma
@example samples/testsuite-support/tests/test_mocked_time.py
@example samples/testsuite-support/tests/test_tasks.py
@example samples/testsuite-support/tests/test_testpoint.py
@example samples/production_service/tests/test_production.py
2 changes: 1 addition & 1 deletion scripts/docs/en/userver/mysql/mysql_driver.md
Original file line number Diff line number Diff line change
@@ -58,7 +58,7 @@ leaking in some hopefully rare cases is acceptable, <br>cmake variable
`USERVER_MYSQL_ALLOW_BUGGY_LIBMARIADB` could be set to force the driver
to leak memory instead of aborting in such cases.

@section info More information
@section mysql_info More information
- For configuring see storages::mysql::Component
- For cluster operations see storages::mysql::Cluster
- For C++ <-> MySQL mapping see @ref scripts/docs/en/userver/mysql/supported_types.md
4 changes: 0 additions & 4 deletions scripts/docs/en/userver/tutorial/kafka_service.md
Original file line number Diff line number Diff line change
@@ -292,13 +292,9 @@ See the full example at:
@example samples/kafka_service/CMakeLists.txt
@example samples/kafka_service/static_config.yaml
@example samples/kafka_service/src/producer_handler.hpp
@example samples/kafka_service/src/producer_handler.cpp
@example samples/kafka_service/src/consumer_handler.hpp
@example samples/kafka_service/src/consumer_handler.hpp
@example samples/kafka_service/src/produce.hpp
@example samples/kafka_service/src/produce.cpp
@example samples/kafka_service/src/consume.hpp
@example samples/kafka_service/src/consume.cpp
@example samples/kafka_service/testsuite/conftest.py
@example samples/kafka_service/testsuite/test_kafka.py
@example samples/kafka_service/unittest/kafka_test.cpp
5 changes: 3 additions & 2 deletions universal/include/userver/formats/json/inline.hpp
Original file line number Diff line number Diff line change
@@ -2,6 +2,7 @@

/// @file userver/formats/json/inline.hpp
/// @brief Inline value builders
/// @ingroup userver_universal

#include <chrono>
#include <cstdint>
@@ -14,13 +15,13 @@ USERVER_NAMESPACE_BEGIN

namespace formats::json {

/// @ingroup userver_universal userver_formats
/// @ingroup userver_formats
///
/// Constructs an object Value from provided key-value pairs
template <typename... Args>
Value MakeObject(Args&&...);

/// @ingroup userver_universal userver_formats
/// @ingroup userver_formats
///
/// Constructs an array Value from provided element list
template <typename... Args>
2 changes: 1 addition & 1 deletion universal/include/userver/utils/bytes_per_second.hpp
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ USERVER_NAMESPACE_BEGIN

namespace utils {

/// @ingroup userver_universal userver_containers
/// @ingroup userver_universal
///
/// @brief Data type that represents `bytes per second` unit
enum class BytesPerSecond : long long {};
2 changes: 1 addition & 1 deletion universal/include/userver/utils/macaddr.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#pragma once

/// @file userver/utils/macaddr/macaddr_base.hpp
/// @file userver/utils/macaddr.hpp
/// @brief MAC address types

#include <array>
4 changes: 2 additions & 2 deletions universal/include/userver/utils/not_null.hpp
Original file line number Diff line number Diff line change
@@ -91,14 +91,14 @@ class NotNull {
T ptr_;
};

/// @ingroup userver_universal userver_containers
/// @ingroup userver_universal
///
/// @brief A `std::shared_ptr` that is guaranteed to be not-null.
/// @see MakeSharedRef
template <typename U>
using SharedRef = NotNull<std::shared_ptr<U>>;

/// @ingroup userver_universal userver_containers
/// @ingroup userver_universal
///
/// @brief A `std::unique_ptr` that is guaranteed to be not-null.
/// @see MakeUniqueRef
4 changes: 2 additions & 2 deletions universal/include/userver/utils/projected_set.hpp
Original file line number Diff line number Diff line change
@@ -69,7 +69,7 @@ void DoInsert(Set& set, Value&& value) {

} // namespace impl::projected_set

/// @ingroup userver_universal userver_containers
/// @ingroup userver_universal
/// @brief A `std::unordered_set` that compares its elements (of type @a Value)
/// based on their @a Projection. It allows to create, essentially, an
/// equivalent of `std::unordered_map` where keys are stored inside values.
@@ -89,7 +89,7 @@ using ProjectedUnorderedSet = std::unordered_set<
impl::projected_set::Compare<Value, Projection, Equal>,
Allocator>;

/// @ingroup userver_universal userver_containers
/// @ingroup userver_universal
/// @brief Same as ProjectedUnorderedSet, but for `std::set`.
template <typename Value, auto Projection, typename Compare = std::less<>, typename Allocator = std::allocator<Value>>
using ProjectedSet = std::set<Value, impl::projected_set::Compare<Value, Projection, Compare>, Allocator>;
10 changes: 4 additions & 6 deletions universal/include/userver/utils/time_of_day.hpp
Original file line number Diff line number Diff line change
@@ -103,7 +103,10 @@ class TimeOfDay<std::chrono::duration<Rep, Period>> {
//@{
/** @name Accessors */
/// @return Hours since midnight
constexpr std::chrono::hours Hours() const noexcept;
constexpr std::chrono::hours Hours() const noexcept {
return std::chrono::duration_cast<std::chrono::hours>(since_midnight_);
}

/// @return Minutes since midnight + Hours
constexpr std::chrono::minutes Minutes() const noexcept;
/// @return Seconds since midnight + Hours + Minutes
@@ -430,11 +433,6 @@ constexpr bool TimeOfDay<std::chrono::duration<Rep, Period>>::operator>=(const T
}
#endif

template <typename Rep, typename Period>
constexpr std::chrono::hours TimeOfDay<std::chrono::duration<Rep, Period>>::Hours() const noexcept {
return std::chrono::duration_cast<std::chrono::hours>(since_midnight_);
}

template <typename Rep, typename Period>
constexpr std::chrono::minutes TimeOfDay<std::chrono::duration<Rep, Period>>::Minutes() const noexcept {
if constexpr (detail::kHasMinutes<Period>) {