Erlang -- docb_xml_check

User's Guide
Reference Manual
Release Notes
PDF
Top

DocBuilder
Reference Manual
Version 0.9.8.9

Expand All
Contract All

Table of Contents

- docbuilder (App)
- docb_gen
  - Top of manual page
  - module/1
  - module/2
  - users_guide/1
  - users_guide/2
- docb_transform
  - Top of manual page
  - file/1
  - file/2
  - Module:head/0
  - Module:top/0
  - Module:bottom/0
  - Module:seealso/1
- docb_xml_check
  - Top of manual page
  - validate/1

# docb_xml_check

### MODULE

docb_xml_check

### MODULE SUMMARY

Validate XML documentation source code

### DESCRIPTION

docb_xml_check contains functions for validating XML documentation source code.

### EXPORTS

validate(File) -> ok | error | {error, badfile}

Types:

File = string()

Validates the XML documentation source code in File. The .xml extension can be omitted.

Returns ok if successful, otherwise error information is printed and the function returns error. If File does not exist, {error, badfile} is returned.