Skip to content

Commit

Permalink
Merge pull request rabbitmq#7461 from rabbitmq/fix-edoc-syntax
Browse files Browse the repository at this point in the history
`rabbit_db*`: Fix EDoc syntax errors
  • Loading branch information
dumbbell authored Feb 28, 2023
2 parents 0058380 + e85ca4e commit 11e7dd0
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
10 changes: 6 additions & 4 deletions deps/rabbit/src/rabbit_db_binding.erl
Original file line number Diff line number Diff line change
Expand Up @@ -343,11 +343,13 @@ get_all_for_destination_in_mnesia(Dst) ->
-spec fold(Fun, Acc) -> Acc when
Fun :: fun((Binding :: rabbit_types:binding(), Acc) -> Acc),
Acc :: any().
%% @doc Folds over all the bindings, making it more efficient than `get_all()` and
%% folding over the returned binding list.
%% Just used by prometheus_rabbitmq_core_metrics_collector to iterate over the bindings.
%% @doc Folds over all the bindings, making it more efficient than `get_all()'
%% and folding over the returned binding list.
%%
%% @returns the fold accumulator
%% Just used by prometheus_rabbitmq_core_metrics_collector to iterate over the
%% bindings.
%%
%% @returns the fold accumulator.
%%
%% @private

Expand Down
2 changes: 1 addition & 1 deletion deps/rabbit/src/rabbit_db_exchange.erl
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ count_in_mnesia() ->
%% `UpdateFun'.
%%
%% @returns the updated exchange record if the record existed and the
%% update succeeded. It returns `not_found` if the transaction fails.
%% update succeeded. It returns `not_found' if the transaction fails.
%%
%% @private

Expand Down
3 changes: 2 additions & 1 deletion deps/rabbit/src/rabbit_db_queue.erl
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,8 @@ exists_in_mnesia(QName) ->
QName :: rabbit_amqqueue:name(),
Exists :: boolean().
%% @doc Indicates if queue named `QName' exists using a consistent read.
%% Just used by `rabbit_classic_queue:is_recoverable` for transient queues.
%%
%% Just used by `rabbit_classic_queue:is_recoverable()' for transient queues.
%%
%% @returns true if the queue exists, false otherwise.
%%
Expand Down

0 comments on commit 11e7dd0

Please sign in to comment.