diff options
author | Lars Thorsen <[email protected]> | 2011-11-18 14:29:06 +0100 |
---|---|---|
committer | Lars Thorsen <[email protected]> | 2011-11-18 14:29:06 +0100 |
commit | 6e024b633005fa53ff67d0222b42d983f8ea85f8 (patch) | |
tree | 1b7320a4c2d882f334c71ee387ffb370a7de32bc /lib/erl_docgen/doc/src/docgen_xml_check.xml | |
parent | 8dc7d8f4931f3c0cb1838c828ae54da08f943f74 (diff) | |
parent | 013e3840532b16308f4bfcf22bde0e6de8d064b2 (diff) | |
download | otp-6e024b633005fa53ff67d0222b42d983f8ea85f8.tar.gz otp-6e024b633005fa53ff67d0222b42d983f8ea85f8.tar.bz2 otp-6e024b633005fa53ff67d0222b42d983f8ea85f8.zip |
Merge branch 'lars/remove-docbuilder/OTP-9721'
* lars/remove-docbuilder/OTP-9721:
[erl_docgen] Add an application ref page
[erl_docgen] Added the info file.
[erl_docgen] Tidy up the documentation moved from docbuilder to erl_docgen
[erl_docgen] Add missing xhtml-special.ent and xhtml-symbol.ent
Remove docbuilder application
[erl_docgen] Update references to modules that changed name
[erl_docgen] Move files from docbuilder to erl_docgen
Diffstat (limited to 'lib/erl_docgen/doc/src/docgen_xml_check.xml')
-rw-r--r-- | lib/erl_docgen/doc/src/docgen_xml_check.xml | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/lib/erl_docgen/doc/src/docgen_xml_check.xml b/lib/erl_docgen/doc/src/docgen_xml_check.xml new file mode 100644 index 0000000000..58cf069d81 --- /dev/null +++ b/lib/erl_docgen/doc/src/docgen_xml_check.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2007</year> + <year>2011</year> + <holder>Ericsson AB, All Rights Reserved</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + </legalnotice> + + <title>docgen_xml_check</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + </header> + <module>docgen_xml_check</module> + <modulesummary>Validate XML documentation source code</modulesummary> + <description> + <p><c>docgen_xml_check</c> contains functions for validating XML + documentation source code.</p> + </description> + + <funcs> + <func> + <name>validate(File) -> ok | error | {error, badfile}</name> + <fsummary>Validate XML source code.</fsummary> + <type> + <v>File = string()</v> + </type> + <desc> + <p>Validates the XML documentation source code in <c>File</c>. + The <c>.xml</c> extension can be omitted.</p> + + <p>Returns <c>ok</c> if successful, otherwise error information + is printed and the function returns <c>error</c>. + If <c>File</c> does not exist, <c>{error, badfile}</c> is + returned.</p> + </desc> + </func> + </funcs> + +</erlref> + |