1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
|
-module(eep48_meta).
-export([fun_with_deprecated_tag/0,
fun_with_since_tag/0]).
-export_type([type_with_deprecated_tag/0,
type_with_since_tag/0]).
%% TODO: Putting @deprecated on consecutive -type and -callback raises an error
%% when EDoc processes the following function.
%% This tag is currently not exported to chunk for types and callbacks anyway,
%% so it's not a critical problem, but might need addressing in the future.
%% FYI, a double comment "%% %%" skips EDoc tag processing - it's a "commented out comment".
%% See {@link edoc_tags:tags/0} for tag scope and allowed multiplicity.
%% TODO: Interestingly, the same does NOT happen for the @since tag,
%% which seems to be processed in the same way.
-type type_with_deprecated_tag() :: ok.
%% %% @deprecated This type is deprecated.
-type type_with_since_tag() :: ok.
%% @since 0.1.0
-callback cb_with_deprecated_tag() -> ok.
%% %% @deprecated This callback is deprecated.
-callback cb_with_since_tag() -> ok.
%% @since 0.1.0
%% @deprecated Deprecated function.
fun_with_deprecated_tag() -> ok.
%% @since 0.1.0
fun_with_since_tag() -> ok.
|