← Back to branch summary

~clint-fewbar/ubuntu/precise/erlang/merge-15b

« back to all changes in this revision

Viewing changes to lib/erl_docgen/doc/src/docgen_xml_check.xml

  • Committer: Package Import Robot
  • Author(s): Sergei Golovan
  • Date: 2011-12-15 19:20:10 UTC
  • mfrom: (1.1.18) (3.5.15 sid)
  • mto: (3.5.16 sid)
  • mto: This revision was merged to the branch mainline in revision 33.
  • Revision ID: package-import@ubuntu.com-20111215192010-jnxcfe3tbrpp0big
Tags: 1:15.b-dfsg-1
* New upstream release.
* Upload to experimental because this release breaks external drivers
  API along with ABI, so several applications are to be fixed.
* Removed SSL patch because the old SSL implementation is removed from
  the upstream distribution.
* Removed never used patch which added native code to erlang beam files.
* Removed the erlang-docbuilder binary package because the docbuilder
  application was dropped by upstream.
* Documented dropping ${erlang-docbuilder:Depends} substvar in
  erlang-depends(1) manpage.
* Made erlang-base and erlang-base-hipe provide virtual package
  erlang-abi-15.b (the number means the first erlang version, which
  provides current ABI).

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/erl_docgen/doc/src/docgen_xml_check.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
 
3
 
 
4
<erlref>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>2007</year>
 
8
      <year>2011</year>
 
9
      <holder>Ericsson AB, All Rights Reserved</holder>
 
10
    </copyright>
 
11
    <legalnotice>
 
12
  The contents of this file are subject to the Erlang Public License,
 
13
  Version 1.1, (the "License"); you may not use this file except in
 
14
  compliance with the License. You should have received a copy of the
 
15
  Erlang Public License along with this software. If not, it can be
 
16
  retrieved online at http://www.erlang.org/.
 
17
 
 
18
  Software distributed under the License is distributed on an "AS IS"
 
19
  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
20
  the License for the specific language governing rights and limitations
 
21
  under the License.
 
22
 
 
23
  The Initial Developer of the Original Code is Ericsson AB.
 
24
    </legalnotice>
 
25
 
 
26
    <title>docgen_xml_check</title>
 
27
    <prepared></prepared>
 
28
    <docno></docno>
 
29
    <date></date>
 
30
    <rev></rev>
 
31
  </header>
 
32
  <module>docgen_xml_check</module>
 
33
  <modulesummary>Validate XML documentation source code</modulesummary>
 
34
  <description>
 
35
    <p><c>docgen_xml_check</c> contains functions for validating XML
 
36
      documentation source code.</p>
 
37
  </description>
 
38
 
 
39
  <funcs>
 
40
    <func>
 
41
      <name>validate(File) -> ok | error | {error, badfile}</name>
 
42
      <fsummary>Validate XML source code.</fsummary>
 
43
      <type>
 
44
        <v>File = string()</v>
 
45
      </type>
 
46
      <desc>
 
47
        <p>Validates the XML documentation source code in <c>File</c>.
 
48
          The <c>.xml</c> extension can be omitted.</p>
 
49
 
 
50
        <p>Returns <c>ok</c> if successful, otherwise error information
 
51
          is printed and the function returns <c>error</c>.
 
52
          If <c>File</c> does not exist, <c>{error, badfile}</c> is
 
53
          returned.</p>
 
54
      </desc>
 
55
    </func>
 
56
  </funcs>
 
57
 
 
58
</erlref>
 
59