Skip to content

fix: remove @doc tags from callback declarations #355

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.

Sign up for GitHub

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

Merged
Taure merged 3 commits into from
Feb 11, 2026
Merged

fix: remove @doc tags from callback declarations #355

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7fd0c48
fix: remove @doc tags from callback declarations in nova_plugin
Taure Feb 10, 2026
e0cd209
Merge branch 'master' into fix/ex-doc-callback-tags
Taure Feb 11, 2026
f273970
Merge branch 'master' into fix/ex-doc-callback-tags
Taure Feb 11, 2026
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
10 changes: 0 additions & 10 deletions src/nova_plugin.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,26 +34,20 @@
{reply, Status :: integer(), Body :: binary()} |
{reply, Status :: integer(), Headers :: [{binary(), binary()}], Body :: binary()}.

%% @doc
%% Start function for the plugin. This function is called when the plugin is started
%% and will return a state that will be passed to the other functions during
%% the life cycle of the plugin. The state can be any term.
%% @end
-callback init() -> State :: nova:state().
-optional_callbacks([init/0]).

%% @doc
%% Stop function for the plugin. This function is called when the application is stopped.
%% It takes a state as argument and should return ok.
%% @end
-callback stop(State :: nova:state()) -> ok.
-optional_callbacks([stop/1]).

%% @doc
%% This function is called before the request is processed. It can modify the request
%% and the nova-state. It takes a state and a map of options as arguments and should return
%% either {ok, NewState}, {break, NewState}, {stop, NewState} or {error, Reason}.
%% @end
-callback pre_request(Req :: cowboy_req:req(), Env :: any(),
Options :: map(), PluginState :: any()) ->
{ok, Req0 :: cowboy_req:req(), NewState :: any()} |
Expand All @@ -65,12 +59,10 @@
{error, Reason :: term()}.
-optional_callbacks([pre_request/4]).

%% @doc
%% This function is called after the request is processed. It can modify the request.
%% It takes a state and a map of options as arguments and should return
%% either {ok, NewState}, {break, NewState}, {stop, NewState} or {error, Reason}.
%% The state is only used if there's another plugin invoked after this one.
%% @end
-callback post_request(Req :: cowboy_req:req(), Env :: any(),
Options :: map(), PluginState :: any()) ->
{ok, Req0 :: cowboy_req:req(), NewState :: any()} |
Expand All @@ -82,10 +74,8 @@
{error, Reason :: term()}.
-optional_callbacks([post_request/4]).

%% @doc
%% This function should return information about the plugin. The information is used
%% in the documentation and in the plugin-listing.
%% @end
-callback plugin_info() -> #{title := binary(),
version := binary(),
url := binary(),
Expand Down