diff options
| author | Lukas Larsson <lukas@erlang.org> | 2020-04-15 17:26:43 +0200 |
|---|---|---|
| committer | Lukas Larsson <lukas@erlang.org> | 2020-04-17 10:28:27 +0200 |
| commit | 3d8889c8088cc95830515fa04c6297def40f2769 (patch) | |
| tree | 33cbe0e8124331d557ab5ad51b6607591e4098e5 /lib/erl_docgen/doc | |
| parent | 9dba151dee21d323c7fb791ef4ca55920a5967bb (diff) | |
| download | erlang-3d8889c8088cc95830515fa04c6297def40f2769.tar.gz | |
docgen: Document the equiv metadata
Diffstat (limited to 'lib/erl_docgen/doc')
| -rw-r--r-- | lib/erl_docgen/doc/src/doc_storage.xml | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/erl_docgen/doc/src/doc_storage.xml b/lib/erl_docgen/doc/src/doc_storage.xml index d4899774b8..2c719b3f20 100644 --- a/lib/erl_docgen/doc/src/doc_storage.xml +++ b/lib/erl_docgen/doc/src/doc_storage.xml @@ -114,6 +114,11 @@ <tag><c>signature := SpecAST</c></tag> <item>The spec AST associated with this function. It is used to render a more descriptive slogan for the documentation entry.</item> + <tag><c>equiv := {Type,Name,Arity}</c></tag> + <item>The current function/type shares documentation with another function/type. + This means that if this and the target function/type are to be shown at the + same time only the prototype of this function/type should will be displayed + and the documentation will use a common body of text.</item> </taglist> </item> </list> |