File 0265-edoc-Use-local-definition-of-context.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0265-edoc-Use-local-definition-of-context.patch of Package erlang (Revision 51223dbfed63638bb2cfdc0d435b5ce4)

Currently displaying revision 51223dbfed63638bb2cfdc0d435b5ce4 , Show latest

From 934133a90660b1a64552bd838ca76d59f0722002 Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Wed, 11 Aug 2021 10:31:51 +0200
Subject: [PATCH] edoc: Use local definition of context

The module edoc_tags is an internal module and thus
we cannot refer to a type within it. So instead we
inline the type into edoc_extract so that the user
can view it.

Closes #5058
---
 lib/edoc/src/edoc_extract.erl | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/lib/edoc/src/edoc_extract.erl b/lib/edoc/src/edoc_extract.erl
index cef5e55703..917faec972 100644
--- a/lib/edoc/src/edoc_extract.erl
+++ b/lib/edoc/src/edoc_extract.erl
@@ -41,6 +41,7 @@
 
 -type filename() :: file:filename().
 -type proplist() :: proplists:proplist().
+-type context() :: module | footer | function | overview | single.
 
 %% @doc Like {@link source/5}, but reads the syntax tree and the
 %% comments from the specified file.
@@ -233,7 +234,7 @@ add_macro_defs(Defs0, Opts, Env) ->
 
 -spec file(File, Context, Env, Opts) -> {ok, Tags} | {error, Reason} when
       File :: filename(),
-      Context :: edoc_tags:tag_flag(),
+      Context :: context(),
       Env :: edoc:env(),
       Opts :: proplist(),
       Tags :: [term()],
@@ -264,7 +265,7 @@ file(File, Context, Env, Opts) ->
 
 -spec text(Text, Context, Env, Opts) -> Tags when
       Text :: string(),
-      Context :: overview,
+      Context :: context(),
       Env :: edoc:env(),
       Opts :: proplist(),
       Tags :: [term()].
-- 
2.31.1

Places

File 0265-edoc-Use-local-definition-of-context.patch of Package erlang (Revision 51223dbfed63638bb2cfdc0d435b5ce4)

Places