summaryrefslogtreecommitdiff
path: root/system/doc/programming_examples
diff options
context:
space:
mode:
authorLukas Larsson <lukas@erlang.org>2020-03-11 10:11:22 +0100
committerLukas Larsson <lukas@erlang.org>2020-03-27 11:02:23 +0100
commit0799c2b0e9ae5fce18d092a153fff884d1dd3912 (patch)
treec7c72465bd01591a9163e5ad17cea92bf3be75ec /system/doc/programming_examples
parent6c6fe8e774f7cde6d158b450fd1ad6c3129dc22e (diff)
downloaderlang-0799c2b0e9ae5fce18d092a153fff884d1dd3912.tar.gz
otp: Convert all <seealso> to more specific variants
We add `seemfa`, `seeerl`, `seetype`, `seeapp`, `seecom`, `seecref` , `seefile` and `seeguide` in order to make it easier to reason about what each link points to without examining the target. This information will then be embedded in the EEP-48 chunks for usage by other tools. The tool used can be found here: https://gist.github.com/garazdawi/68527d92ae5b37c8f129bfbdfffdfa68
Diffstat (limited to 'system/doc/programming_examples')
-rw-r--r--system/doc/programming_examples/bit_syntax.xml12
-rw-r--r--system/doc/programming_examples/funs.xmlsrc6
-rw-r--r--system/doc/programming_examples/records.xml2
3 files changed, 10 insertions, 10 deletions
diff --git a/system/doc/programming_examples/bit_syntax.xml b/system/doc/programming_examples/bit_syntax.xml
index 4da53cfdb3..cc89f3a469 100644
--- a/system/doc/programming_examples/bit_syntax.xml
+++ b/system/doc/programming_examples/bit_syntax.xml
@@ -33,7 +33,7 @@
<section>
<title>Introduction</title>
<p>The complete specification for the bit syntax appears in the
- <seealso marker="doc/reference_manual:expressions#bit_syntax">Reference Manual</seealso>.</p>
+ <seeguide marker="system/reference_manual:expressions#bit_syntax">Reference Manual</seeguide>.</p>
<p>In Erlang, a Bin is used for constructing binaries and matching
binary patterns. A Bin is written with the following syntax:</p>
<code type="none"><![CDATA[
@@ -150,14 +150,14 @@ end.]]></code>
</list>
<p>Default values are used when specifications are missing.
The default values are described in
- <seealso marker="#Defaults">Defaults</seealso>.</p>
+ <seeguide marker="#Defaults">Defaults</seeguide>.</p>
<p>The <c>Value</c> part is any expression, when used in binary construction.
Used in binary matching, the <c>Value</c> part must
be a literal or a variable. For more information about
the <c>Value</c> part, see
- <seealso marker="#Constructing Binaries and Bitstrings">Constructing Binaries and Bitstrings</seealso>
+ <seeguide marker="#Constructing Binaries and Bitstrings">Constructing Binaries and Bitstrings</seeguide>
and
- <seealso marker="#Matching Binaries">Matching Binaries</seealso>.</p>
+ <seeguide marker="#Matching Binaries">Matching Binaries</seeguide>.</p>
<p>The <c>Size</c> part of the segment multiplied by the unit in
<c>TypeSpecifierList</c> (described later) gives the number
of bits for the segment. In construction, <c>Size</c> is any
@@ -168,7 +168,7 @@ end.]]></code>
<taglist>
<tag>Type</tag>
<item>The most commonly used types are <c>integer</c>, <c>float</c>, and <c>binary</c>.
- See <seealso marker="doc/reference_manual:expressions#bit_syntax">Bit Syntax Expressions in the Reference Manual</seealso> for a complete description.
+ See <seeguide marker="system/reference_manual:expressions#bit_syntax">Bit Syntax Expressions in the Reference Manual</seeguide> for a complete description.
</item>
<tag>Signedness</tag>
<item>The signedness specification can be either <c>signed</c>
@@ -293,7 +293,7 @@ X:4/little-signed-integer-unit:8</code>
an integer, or a floating point literal. Expressions are not
allowed.</p>
<p><c>Size</c> must be a
- <seealso marker="doc/reference_manual:expressions#guard_expressions">guard expression</seealso>, which can use literals and previously bound variables.
+ <seeguide marker="system/reference_manual:expressions#guard_expressions">guard expression</seeguide>, which can use literals and previously bound variables.
The following is not allowed:</p>
<code type="none"><![CDATA[
foo(N, <<X:N,T/binary>>) ->
diff --git a/system/doc/programming_examples/funs.xmlsrc b/system/doc/programming_examples/funs.xmlsrc
index bb519be612..b6dc2da249 100644
--- a/system/doc/programming_examples/funs.xmlsrc
+++ b/system/doc/programming_examples/funs.xmlsrc
@@ -112,9 +112,9 @@ foreach(fun(Pid) -> Pid ! M end, L)</code>
<section>
<title>Syntax of Funs</title>
- <p>Funs are written with the following syntax (see <seealso
- marker="doc/reference_manual:expressions#funs">Fun Expressions
- </seealso> for full description):</p>
+ <p>Funs are written with the following syntax (see <seeguide
+ marker="system/reference_manual:expressions#funs">Fun Expressions
+ </seeguide> for full description):</p>
<code type="none">
F = fun (Arg1, Arg2, ... ArgN) ->
...
diff --git a/system/doc/programming_examples/records.xml b/system/doc/programming_examples/records.xml
index 074aa636b4..d74ce22e4e 100644
--- a/system/doc/programming_examples/records.xml
+++ b/system/doc/programming_examples/records.xml
@@ -92,7 +92,7 @@ person</pre>
<p>This is because record definitions are only available
at compile time, not at runtime. For details on records
in the shell, see the
- <seealso marker="stdlib:shell">shell(3)</seealso>
+ <seeerl marker="stdlib:shell">shell(3)</seeerl>
manual page in STDLIB.</p>
</section>