diff options
Diffstat (limited to 'lib/erl_docgen')
-rw-r--r-- | lib/erl_docgen/doc/src/Makefile | 3 | ||||
-rw-r--r-- | lib/erl_docgen/doc/src/doc_storage.xml | 61 | ||||
-rw-r--r-- | lib/erl_docgen/doc/src/part.xml | 1 |
3 files changed, 64 insertions, 1 deletions
diff --git a/lib/erl_docgen/doc/src/Makefile b/lib/erl_docgen/doc/src/Makefile index 12402edb21..33eb44a049 100644 --- a/lib/erl_docgen/doc/src/Makefile +++ b/lib/erl_docgen/doc/src/Makefile @@ -47,7 +47,8 @@ XML_CHAPTER_FILES = \ inline_tags.xml \ header_tags.xml \ character_entities.xml \ - block_tags.xml + block_tags.xml \ + doc_storage.xml BOOK_FILES = book.xml diff --git a/lib/erl_docgen/doc/src/doc_storage.xml b/lib/erl_docgen/doc/src/doc_storage.xml new file mode 100644 index 0000000000..9eee863e3d --- /dev/null +++ b/lib/erl_docgen/doc/src/doc_storage.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="utf-8" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>1997</year><year>2016</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + </legalnotice> + <title>Documentation Storage</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + <file>doc_storage.xml</file> + </header> + + <section> + <title>EEP-48: Documentation storage and format</title> + <p><url href="https://www.erlang.org/erlang-enhancement-proposals/eep-0048.html">EEP-48</url> + defines a common documentation storage format for module documentation in the Erlang/OTP + ecosystem. Erl_Docgen can generate documentation in this format from XML files following + the DTD's descibed in the other User's Guides in this application.</p> + <p>Some special considerations have to be taken when writing documentation that + should also be available through EEP-48 style storage.</p> + <list> + <item>The <c>#PCDATA</c> within <c><name></c> tags must be parseable to figure out the arity of the function.</item> + <item>It is not allowed to mix <c><name></c> tags with #PCDATA and attributes.</item> + <item>All <c><name></c> tags within <c><func></c> has to have a <c>since</c> attribute.</item> + <item>All callback function documentations have to start with a <c>Module</c> prefix.</item> + </list> + </section> + + <section> + <title>Erlang Documentation Format</title> + <p>When generating documentation for generic storage</p> + </section> + + <section> + <title>See Also</title> + <p> + <seealso marker="stdlib:shell_docs"><c>shell_docs(3)</c></seealso>, + <seealso marker="kernel:code#get_doc-1"><c>code:get_doc(3)</c></seealso> + </p> + </section> + +</chapter> diff --git a/lib/erl_docgen/doc/src/part.xml b/lib/erl_docgen/doc/src/part.xml index 0e97af7169..91ff979af5 100644 --- a/lib/erl_docgen/doc/src/part.xml +++ b/lib/erl_docgen/doc/src/part.xml @@ -40,5 +40,6 @@ <xi:include href="block_tags.xml"/> <xi:include href="inline_tags.xml"/> <xi:include href="character_entities.xml"/> + <xi:include href="doc_storage.xml"/> </part> |