diff options
| author | Lukas Larsson <lukas@erlang.org> | 2020-03-11 10:34:52 +0100 |
|---|---|---|
| committer | Lukas Larsson <lukas@erlang.org> | 2020-03-27 11:02:23 +0100 |
| commit | d773632085c8a81a2fc7d860bf26a2b707ede5d5 (patch) | |
| tree | e81de4996b3a04cc5c87de62fbbaed7608626967 /lib/erl_docgen/doc | |
| parent | 303611f434ff714a990e555e13a4f7e9c740dad7 (diff) | |
| download | erlang-d773632085c8a81a2fc7d860bf26a2b707ede5d5.tar.gz | |
docgen: Add documentation for new see* tags
Diffstat (limited to 'lib/erl_docgen/doc')
| -rw-r--r-- | lib/erl_docgen/doc/src/block_tags.xml | 6 | ||||
| -rw-r--r-- | lib/erl_docgen/doc/src/inline_tags.xml | 97 |
2 files changed, 97 insertions, 6 deletions
diff --git a/lib/erl_docgen/doc/src/block_tags.xml b/lib/erl_docgen/doc/src/block_tags.xml index b2b8829ced..ecf71db479 100644 --- a/lib/erl_docgen/doc/src/block_tags.xml +++ b/lib/erl_docgen/doc/src/block_tags.xml @@ -224,8 +224,8 @@ start(Pid) -> <title><pre> - Pre-formatted Text</title> <p>Used for documentation of system interaction. Can contain text, - <seeguide marker="inline_tags#seealsoTAG">seealso</seeguide>, - <seeguide marker="inline_tags#urlTAG">url</seeguide> and + <seeguide marker="inline_tags#seeTAG"><see*> tags</seeguide>, + <seeguide marker="inline_tags#urlTAG"><url></seeguide> and <c><![CDATA[<input>]]></c> tags.</p> <p>The <c><![CDATA[<input>]]></c> tag is used to highlight user @@ -290,7 +290,7 @@ Eshell V5.5.3 (abort with ^G) <p><c><![CDATA[<tag>]]></c> can contain plain text, <seeguide marker="inline_tags#cTAG"><c></seeguide>, <seeguide marker="inline_tags#emTAG"><em></seeguide>, - <seeguide marker="inline_tags#seealsoTAG"><seealso></seeguide> + <seeguide marker="inline_tags#seeTAG"><see*> tags</seeguide> and <seeguide marker="inline_tags#urlTAG"><url></seeguide> tags.</p> diff --git a/lib/erl_docgen/doc/src/inline_tags.xml b/lib/erl_docgen/doc/src/inline_tags.xml index 6d80d47997..11f73595f2 100644 --- a/lib/erl_docgen/doc/src/inline_tags.xml +++ b/lib/erl_docgen/doc/src/inline_tags.xml @@ -86,13 +86,104 @@ <marker id="marker_example"/> </pre> - <p>The <seeguide marker="#seealsoTAG"><seealso></seeguide> tag - is used to refer to the marker.</p> + <p>The <seeguide marker="#seeTAG"><see*></seeguide> tags + are used to refer to the marker.</p> <p>The <c><![CDATA[<marker>]]></c> tag is both a block- and an inline tag.</p> </section> - + + <section> + <marker id="seeTAG"/> + <title><see*> - See tags</title> + <p>A cross reference (hypertext link) to a marker in the same file, + a marker in another file, or (the top of) another file, given by + the <c>marker</c> attribute. The syntax used within the <c>marker</c> + attribute is <c>application:file#anchor</c> for the general case. + <c>application</c> and <c>file</c> can be omitted if the link target + is the current application or file.</p> + <p>There are several different see tags that are to be used depending on + what it is that they point to.</p> + <taglist> + <tag><seemfa></tag> + <item> + <p>Points to an MFA using the syntax <c>application:module#function/arity</c>. + These links must point to functions documented in a <funcs> section. + Examples:</p> + <pre><![CDATA[ +<seemfa marker="stdlib:string#length/1">string:length/1</seemfa> +<seemfa marker="string#length/1">string:length/1</seemfa> +<seemfa marker="#length/1">string:length/1</seemfa> +]]></pre> + results in: <seemfa marker="stdlib:string#length/1">string:length/1</seemfa>. + </item> + <tag><seeerl></tag> + <item> + <p>Points to an Erlang module or a custom <seeguide marker="#markerTAG">marker</seeguide> + within a module. Example:</p> + <pre><![CDATA[ +<seeerl marker="stdlib:string">string(3)</seemfa>, +<seeerl marker="stdlib:string#oldapi">Old API in string</seemfa> +]]></pre> + results in: <seeerl marker="stdlib:string">string(3)</seeerl>,<seeerl marker="stdlib:string#oldapi">Old API in string</seeerl>. + </item> + <tag><seetype></tag> + <item> + <p>Points to a type using the syntax <c>application:module#type</c>. + These links must point to types documented in a <datatypes> section. + Example:</p> + <pre><![CDATA[ +<seetype marker="stdlib:string#oldapi">string::grapheme_cluster()</seetype> +]]></pre> + results in: <seetype marker="stdlib:string#grapheme_cluster">string::grapheme_cluster()</seetype>. + </item> + <tag><seeapp></tag> + <item><p>Points to the application documentation. <c>index</c> can be used as the target file. + Example:</p> + <pre><![CDATA[ +<seeapp marker="stdlib:STDLIB_app">STDLIB app</seeapp>, +<seeapp marker="stdlib:index">STDLIB index</seeapp> +]]></pre> + results in: <seeapp marker="stdlib:STDLIB_app">STDLIB</seeapp>, <seeapp marker="stdlib:index">STDLIB</seeapp>. + </item> + <tag><seecom></tag> + <item> + <p>Points to the documentation of any command line utility. Example:</p> + <pre><![CDATA[ +<seecom marker="erts:epmd">epmd</seecom> +]]></pre> + results in: <seecom marker="erts:epmd">epmd</seecom>. + </item> + <tag><seecref></tag> + <item> + <p>Points to the documentation of any C reference. Example:</p> + <pre><![CDATA[ +<seecref marker="erts:erl_nif">erl_nif</seecref> +]]></pre> + results in: <seecref marker="erts:erl_nif">erl_nif</seecref>. + </item> + <tag><seefile></tag> + <item> + <p>Points to the documentation of a file format. Example:</p> + <pre><![CDATA[ +<seefile marker="kernel:config">config(3)</seefile> +]]></pre> + results in: <seefile marker="kernel:config">config(3)</seefile>. + </item> + <tag><seeguide></tag> + <item> + <p>Points to the User"s Guide of any application. + <c>index</c> can be used as the target file. Example:</p> + <pre><![CDATA[ +<seeguide marker="kernel:index">Kernel User's Guide Index</seeguide>, +<seeguide marker="kernel:logger_chapter">Logging in the Kernel User's Guide</seeguide> +]]></pre> + results in: <seeguide marker="kernel:index">Kernel User's Guide Index</seeguide>, + <seeguide marker="kernel:logger_chapter">Logging in the Kernel User's Guide</seeguide>. + </item> + </taglist> + </section> + <section> <marker id="urlTAG"></marker> <title><url> - Non-Local Cross Reference</title> |