actually adding the new docs now - I'm also using "NaturalDocs -i lib -o HTML doc -p doc_config -s Small OL" to build docs now
git-svn-id: http://svn.openlayers.org/sandbox/tschaub/naturaldocs/doc@3382 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
Tim Schaub
@@ -0,0 +1,34 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
|
||||
|
||||
<html><head><title>OpenLayers.Format - OpenLayers</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script></head><body class=UnframedPage onLoad="NDOnLoad()"><script language=JavaScript><!--
|
||||
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
|
||||
|
||||
<!-- Generated by Natural Docs, version 1.35 -->
|
||||
<!-- http://www.naturaldocs.org -->
|
||||
|
||||
<!-- saved from url=(0026)http://www.naturaldocs.org -->
|
||||
|
||||
<table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td class=MenuSection valign=top><!--START_ND_MENU--><div class=MTitle>OpenLayers<div class=MSubTitle>JavaScript Mapping Library</div></div><div class=MEntry><div class=MFile><a href="../OpenLayers-js.html">OpenLayers</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">OpenLayers</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="BaseTypes-js.html">Base Types</a></div></div><div class=MEntry><div class=MFile><a href="Console-js.html">Console</a></div></div><div class=MEntry><div class=MFile id=MSelected>Format</div></div><div class=MEntry><div class=MFile><a href="Layer-js.html">Layer</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Layer</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="Layer/Image-js.html">Image</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Vector-js.html">Vector</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WMS-js.html">WMS</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Map-js.html">Map</a></div></div><div class=MEntry><div class=MFile><a href="Tile-js.html">Tile</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Tile</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="Tile/Image-js.html">Image</a></div></div><div class=MEntry><div class=MFile><a href="Tile/WFS-js.html">WFS</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">Index</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MIndex><a href="../../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Constants.html">Constants</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Properties.html">Properties</a></div></div></div></div></div><!--END_ND_MENU--></td>
|
||||
|
||||
<td class=ContentSection valign=top><div class=CClass id=MainTopic><div class=CTopic><h1 class=CTitle><a name="OpenLayers.Format"></a>OpenLayers.<span class=HB> </span>Format</h1><div class=CBody><p class=CParagraph>Base class for format reading/writing a variety of formats. Subclasses of OpenLayers.Format are expected to have read and write methods.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr><td class=SEntrySize><div class=SMain><div class=SEntry><a href="#OpenLayers.Format" >OpenLayers.<span class=HB> </span>Format</a></div></div></td><td class=SDescriptionSize><div class=SMain><div class=SDescription>Base class for format reading/writing a variety of formats. </div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Format.Functions" >Functions</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Format.OpenLayers.Format" >OpenLayers.<span class=HB> </span>Format</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Instances of this class are not useful. </div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Format.read" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">read</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Read data from a string, and return an object whose type depends on the subclass.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Format.write" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">write</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Accept an object, and return a string.</div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Format.Constants" >Constants</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Format.CLASS_NAME" >CLASS_NAME</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{String} OpenLayers.Format</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
|
||||
|
||||
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Format.Functions"></a>Functions</h3></div></div>
|
||||
|
||||
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Format.OpenLayers.Format"></a>OpenLayers.<span class=HB> </span>Format</h3><div class=CBody><p class=CParagraph>Instances of this class are not useful. See one of the subclasses.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} An optional object with properties to set on the format</td></tr></table><h4 class=CHeading>Return</h4><p class=CParagraph>An instance of OpenLayers.Format</p></div></div></div>
|
||||
|
||||
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Format.read"></a>read</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>read: function(</td><td class=PParameter nowrap>data</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>Read data from a string, and return an object whose type depends on the subclass.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data</td><td class=CDLDescription>{string} Data to read/parse.</td></tr></table><h4 class=CHeading>Return</h4><p class=CParagraph>Depends on the subclass</p></div></div></div>
|
||||
|
||||
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Format.write"></a>write</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>write: function(</td><td class=PParameter nowrap>object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>Accept an object, and return a string.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>object</td><td class=CDLDescription>{Object} Object to be serialized</td></tr></table><h4 class=CHeading>Return</h4><p class=CParagraph>{String} A string representation of the object.</p></div></div></div>
|
||||
|
||||
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Format.Constants"></a>Constants</h3></div></div>
|
||||
|
||||
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Format.CLASS_NAME"></a>CLASS_NAME</h3><div class=CBody><p class=CParagraph>{String} OpenLayers.Format</p></div></div></div>
|
||||
|
||||
</td>
|
||||
|
||||
</tr></table><div class=Footer><!--START_ND_FOOTER-->Generated by <a href="http://www.naturaldocs.org">Natural Docs</a><!--END_ND_FOOTER--></div>
|
||||
<!--START_ND_TOOLTIPS-->
|
||||
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>read: function(</td><td class=PParameter nowrap>data</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Read data from a string, and return an object whose type depends on the subclass.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>write: function(</td><td class=PParameter nowrap>object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Accept an object, and return a string.</div></div><!--END_ND_TOOLTIPS-->
|
||||
|
||||
<script language=JavaScript><!--
|
||||
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user