diff options
author | Lars Thorsen <[email protected]> | 2011-11-17 12:27:59 +0100 |
---|---|---|
committer | Lars Thorsen <[email protected]> | 2011-11-18 14:28:44 +0100 |
commit | 4424b10d7054025eef3e721f64fb53ad7b357282 (patch) | |
tree | 3021ca22d285757cd63054e6925b7c56ec8724a7 /lib/erl_docgen/doc/src/block_tags.xml | |
parent | ebaf44e2d10bdf6bca2fc83d10e75e144dcbde2d (diff) | |
download | otp-4424b10d7054025eef3e721f64fb53ad7b357282.tar.gz otp-4424b10d7054025eef3e721f64fb53ad7b357282.tar.bz2 otp-4424b10d7054025eef3e721f64fb53ad7b357282.zip |
[erl_docgen] Tidy up the documentation moved from docbuilder to erl_docgen
Diffstat (limited to 'lib/erl_docgen/doc/src/block_tags.xml')
-rw-r--r-- | lib/erl_docgen/doc/src/block_tags.xml | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/lib/erl_docgen/doc/src/block_tags.xml b/lib/erl_docgen/doc/src/block_tags.xml index f5ba083f38..0900d7f008 100644 --- a/lib/erl_docgen/doc/src/block_tags.xml +++ b/lib/erl_docgen/doc/src/block_tags.xml @@ -4,7 +4,7 @@ <chapter> <header> <copyright> - <year>1997</year><year>2009</year> + <year>1997</year><year>2011</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -33,7 +33,7 @@ as a paragraph or a list.</p> <p>The following subset of block tags are common for all DTDs in - the DocBuilder DTD suite: + the OTP DTD suite: <marker id="block_subset"></marker> <seealso marker="#pTAG"><p></seealso>, <seealso marker="#preTAG"><pre></seealso>, @@ -81,7 +81,7 @@ sum([]) -> </code> <p>There is an attribute <c>type = "erl" | "c" | "none"</c>, but - currently this attribute is ignored by DocBuilder. Default value + currently this attribute is ignored. Default value is <c>"none"</c></p> <note> @@ -99,18 +99,18 @@ sum([]) -> gives the file name and <c>tag</c> defines a string which delimits the code snippet. Example:</p> <pre> -<codeinclude file="gazonk" tag="%% Erlang example"/> +<codeinclude file="example.txt" tag="%% Erlang example"/> </pre> <p>results in:</p> - <codeinclude file="gazonk" tag="%% Erlang example"/> + <codeinclude file="example.txt" tag="%% Erlang example"/> - <p>provided there is a file named <c>gazonk</c> looking like this: + <p>provided there is a file named <c>examples.txt</c> looking like this: </p> <code> ... %% Erlang example --module(gazonk). +-module(example). start() -> {error,"Pid required!"}. @@ -125,7 +125,7 @@ start(Pid) -> included.</p> <p>There is also an attribute <c>type = "erl" | "c" | "none"</c>, but - currently this attribute is ignored by DocBuilder. Default value + currently this attribute is ignored. Default value is <c>"none"</c></p> </section> |