File: eep48_meta.erl

package info (click to toggle)
erlang 1%3A25.2.3%2Bdfsg-1%2Bdeb12u3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 219,972 kB
  • sloc: erlang: 1,440,803; xml: 473,412; ansic: 392,382; cpp: 164,287; makefile: 17,392; sh: 13,842; lisp: 9,675; java: 8,578; asm: 6,426; perl: 5,527; python: 5,469; javascript: 610; pascal: 126; sed: 72; php: 3
file content (35 lines) | stat: -rw-r--r-- 1,126 bytes parent folder | download | duplicates (5)
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.