<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html xmlns:fn="http://www.w3.org/2005/02/xpath-functions"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css"> <title>Erlang -- docb_xml_check</title> </head> <body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container"> <script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript"> <!-- function getWinHeight() { var myHeight = 0; if( typeof( window.innerHeight ) == 'number' ) { //Non-IE myHeight = window.innerHeight; } else if( document.documentElement && ( document.documentElement.clientWidth || document.documentElement.clientHeight ) ) { //IE 6+ in 'standards compliant mode' myHeight = document.documentElement.clientHeight; } else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) { //IE 4 compatible myHeight = document.body.clientHeight; } return myHeight; } function setscrollpos() { var objf=document.getElementById('loadscrollpos'); document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2; } function addEvent(obj, evType, fn){ if (obj.addEventListener){ obj.addEventListener(evType, fn, true); return true; } else if (obj.attachEvent){ var r = obj.attachEvent("on"+evType, fn); return r; } else { return false; } } addEvent(window, 'load', setscrollpos); //--></script><div id="leftnav"><div class="innertube"> <img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/docbuilder-0.9.8.7.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>DocBuilder</strong><br><strong>Reference Manual</strong><br><small>Version 0.9.8.7</small></p> <br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Table of Contents</strong></small></p> <ul class="flipMenu"> <li title="docbuilder (App)"><a href="docbuilder_app.html">docbuilder (App) </a></li> <li id="no" title="docb_gen " expanded="false">docb_gen<ul> <li><a href="docb_gen.html"> Top of manual page </a></li> <li title="module-1"><a href="docb_gen.html#module-1">module/1</a></li> <li title="module-2"><a href="docb_gen.html#module-2">module/2</a></li> <li title="users_guide-1"><a href="docb_gen.html#users_guide-1">users_guide/1</a></li> <li title="users_guide-2"><a href="docb_gen.html#users_guide-2">users_guide/2</a></li> </ul> </li> <li id="no" title="docb_transform " expanded="false">docb_transform<ul> <li><a href="docb_transform.html"> Top of manual page </a></li> <li title="file-1"><a href="docb_transform.html#file-1">file/1</a></li> <li title="file-2"><a href="docb_transform.html#file-2">file/2</a></li> <li title="Module:head-0"><a href="docb_transform.html#Module:head-0">Module:head/0</a></li> <li title="Module:top-0"><a href="docb_transform.html#Module:top-0">Module:top/0</a></li> <li title="Module:bottom-0"><a href="docb_transform.html#Module:bottom-0">Module:bottom/0</a></li> <li title="Module:seealso-1"><a href="docb_transform.html#Module:seealso-1">Module:seealso/1</a></li> </ul> </li> <li id="loadscrollpos" title="docb_xml_check " expanded="true">docb_xml_check<ul> <li><a href="docb_xml_check.html"> Top of manual page </a></li> <li title="validate-1"><a href="docb_xml_check.html#validate-1">validate/1</a></li> </ul> </li> </ul> </div></div> <div id="content"> <div class="innertube"> <!-- refpage --><center><h1>docb_xml_check</h1></center> <h3>MODULE</h3> <div class="REFBODY">docb_xml_check</div> <h3>MODULE SUMMARY</h3> <div class="REFBODY">Validate XML documentation source code</div> <h3>DESCRIPTION</h3> <div class="REFBODY"><p> <p><span class="code">docb_xml_check</span> contains functions for validating XML documentation source code.</p> </p></div> <h3>EXPORTS</h3> <p><a name="validate-1"><span class="bold_code">validate(File) -> ok | error | {error, badfile}</span></a><br></p> <div class="REFBODY"> <p>Types:</p> <div class="REFTYPES"> <span class="bold_code">File = string()</span><br> </div> </div> <div class="REFBODY"><p> <p>Validates the XML documentation source code in <span class="code">File</span>. The <span class="code">.xml</span> extension can be omitted.</p> <p>Returns <span class="code">ok</span> if successful, otherwise error information is printed and the function returns <span class="code">error</span>. If <span class="code">File</span> does not exist, <span class="code">{error, badfile}</span> is returned.</p> </p></div> </div> <div class="footer"> <hr> <p>Copyright © 1997-2010 Ericsson AB. All Rights Reserved.</p> </div> </div> </div></body> </html>