File: docb_xml_check.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (24 lines) | stat: -rw-r--r-- 671 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
.TH docb_xml_check 3 "docbuilder  0.9.8.4" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
docb_xml_check \- Validate XML documentation source code
.SH DESCRIPTION
.LP
\fIdocb_xml_check\fR contains functions for validating XML documentation source code\&.

.SH EXPORTS
.LP
.B
validate(File) -> ok | error | {error, badfile}
.br
.RS
.TP
Types
File = string()
.br
.RE
.RS
.LP
Validates the XML documentation source code in \fIFile\fR\&. The \fI\&.xml\fR extension can be omitted\&.
.LP
Returns \fIok\fR if successful, otherwise error information is printed and the function returns \fIerror\fR\&. If \fIFile\fR does not exist, \fI{error, badfile}\fR is returned\&.
.RE