diff options
| author | Lukas Larsson <lukas@erlang.org> | 2020-11-18 14:06:29 +0100 |
|---|---|---|
| committer | Lukas Larsson <lukas@erlang.org> | 2020-11-18 14:06:29 +0100 |
| commit | 8706146d0f88e822abfa4a773e1ba953bf4c2a17 (patch) | |
| tree | 9edf567373a7b2e5051a297624702dc57e59b106 /lib/kernel/doc | |
| parent | f2069747b6bc540690add620e78c2d1afedb5f09 (diff) | |
| parent | 81508c3aa2016cbaec542b4b8047cb5407836557 (diff) | |
| download | erlang-8706146d0f88e822abfa4a773e1ba953bf4c2a17.tar.gz | |
Merge branch 'maint'
Diffstat (limited to 'lib/kernel/doc')
| -rw-r--r-- | lib/kernel/doc/src/code.xml | 4 | ||||
| -rw-r--r-- | lib/kernel/doc/src/eep48_chapter.xml | 3 |
2 files changed, 5 insertions, 2 deletions
diff --git a/lib/kernel/doc/src/code.xml b/lib/kernel/doc/src/code.xml index 82c91318c3..81c0cf4f0d 100644 --- a/lib/kernel/doc/src/code.xml +++ b/lib/kernel/doc/src/code.xml @@ -779,8 +779,8 @@ rpc:call(Node, code, load_binary, [Module, Filename, Binary]), <c>{error,missing}</c>. </p> <p>For more information about the documentation chunk see - <seeguide marker="erl_docgen:doc_storage">Documentation Storage</seeguide> - in Erl_Docgen's User's Guide.</p> + <seeguide marker="kernel:eep48_chapter">Documentation Storage and Format</seeguide> + in Kernel's User's Guide.</p> </desc> </func> <func> diff --git a/lib/kernel/doc/src/eep48_chapter.xml b/lib/kernel/doc/src/eep48_chapter.xml index db5d13eb7a..2173dfd949 100644 --- a/lib/kernel/doc/src/eep48_chapter.xml +++ b/lib/kernel/doc/src/eep48_chapter.xml @@ -38,6 +38,9 @@ <p>To fetch the EEP-48 documentation for a module you can use <seemfa marker="code#get_doc/1"><c>code:get_doc/1</c></seemfa>.</p> + <p>To render the EEP-48 documentation for an Erlang module you can use + <seemfa marker="stdlib:shell_docs#render/2"><c>shell_docs:render/2</c></seemfa>.</p> + <section> <title>the "Docs" storage</title> <p>To look for documentation for a module name example, a tool should:</p> |