Added javadocs, made minor changes to the comments

author: Eduardo Pedroni <ep625@york.ac.uk> 2014-05-06 14:29:37 +0100
committer: Eduardo Pedroni <ep625@york.ac.uk> 2014-05-06 14:29:37 +0100
commit: 8189116ea4b5db4675e31dfd04a5687d55e29262 (patch)
tree: c1815021452a888f8838f1628d8fb4689777e73e /doc/jcgp/gui/settings/parameters/class-use/GUIParameter.html
parent: aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff)
1 files changed, 197 insertions, 0 deletions
diff --git a/doc/jcgp/gui/settings/parameters/class-use/GUIParameter.html b/doc/jcgp/gui/settings/parameters/class-use/GUIParameter.html
new file mode 100644
index 0000000..def915d
--- /dev/null
+++ b/doc/jcgp/gui/settings/parameters/class-use/GUIParameter.html
@@ -0,0 +1,197 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_05) on Tue May 06 14:28:07 BST 2014 -->
+<title>Uses of Class jcgp.gui.settings.parameters.GUIParameter</title>
+<meta name="date" content="2014-05-06">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+    try {
+        if (location.href.indexOf('is-external=true') == -1) {
+            parent.document.title="Uses of Class jcgp.gui.settings.parameters.GUIParameter";
+        }
+    }
+    catch(err) {
+    }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="../package-summary.html">Package</a></li>
+<li><a href="../../../../../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">Class</a></li>
+<li class="navBarCell1Rev">Use</li>
+<li><a href="../package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-files/index-1.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?jcgp/gui/settings/parameters/class-use/GUIParameter.html" target="_top">Frames</a></li>
+<li><a href="GUIParameter.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_top");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+</script>
+</div>
+<a name="skip.navbar.top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h2 title="Uses of Class jcgp.gui.settings.parameters.GUIParameter" class="title">Uses of Class<br>jcgp.gui.settings.parameters.GUIParameter</h2>
+</div>
+<div class="classUseContainer">
+<ul class="blockList">
+<li class="blockList">
+<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
+<caption><span>Packages that use <a href="../../../../../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">GUIParameter</a></span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Package</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="#jcgp.gui.settings.parameters">jcgp.gui.settings.parameters</a></td>
+<td class="colLast">&nbsp;</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
+<ul class="blockList">
+<li class="blockList"><a name="jcgp.gui.settings.parameters">
+<!--   -->
+</a>
+<h3>Uses of <a href="../../../../../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">GUIParameter</a> in <a href="../../../../../jcgp/gui/settings/parameters/package-summary.html">jcgp.gui.settings.parameters</a></h3>
+<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation">
+<caption><span>Subclasses of <a href="../../../../../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">GUIParameter</a> in <a href="../../../../../jcgp/gui/settings/parameters/package-summary.html">jcgp.gui.settings.parameters</a></span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Class and Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jcgp/gui/settings/parameters/GUIBooleanParameter.html" title="class in jcgp.gui.settings.parameters">GUIBooleanParameter</a></span></code>
+<div class="block">This extension of @code{GUIParameter} uses a @code{CheckBox} to display
+ the value of a @code{BooleanParameter}.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jcgp/gui/settings/parameters/GUIDoubleParameter.html" title="class in jcgp.gui.settings.parameters">GUIDoubleParameter</a></span></code>
+<div class="block">This extension of @code{GUIParameter} uses a @code{TextField} to display
+ the value of a @code{DoubleParameter}.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jcgp/gui/settings/parameters/GUIIntegerParameter.html" title="class in jcgp.gui.settings.parameters">GUIIntegerParameter</a></span></code>
+<div class="block">This extension of @code{GUIParameter} uses a @code{TextField} to display
+ the value of a @code{IntegerParameter}.</div>
+</td>
+</tr>
+</tbody>
+</table>
+<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
+<caption><span>Methods in <a href="../../../../../jcgp/gui/settings/parameters/package-summary.html">jcgp.gui.settings.parameters</a> that return <a href="../../../../../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">GUIParameter</a></span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><code>static <a href="../../../../../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">GUIParameter</a>&lt;?&gt;</code></td>
+<td class="colLast"><span class="typeNameLabel">GUIParameter.</span><code><span class="memberNameLink"><a href="../../../../../jcgp/gui/settings/parameters/GUIParameter.html#create-jcgp.backend.parameters.Parameter-jcgp.gui.settings.SettingsPane-">create</a></span>(<a href="../../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a>&lt;?&gt;&nbsp;parameter,
+      <a href="../../../../../jcgp/gui/settings/SettingsPane.html" title="class in jcgp.gui.settings">SettingsPane</a>&nbsp;sp)</code>
+<div class="block">Factory method to create @code{GUIParameter}s from @code{Parameter}s.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="../package-summary.html">Package</a></li>
+<li><a href="../../../../../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">Class</a></li>
+<li class="navBarCell1Rev">Use</li>
+<li><a href="../package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-files/index-1.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?jcgp/gui/settings/parameters/class-use/GUIParameter.html" target="_top">Frames</a></li>
+<li><a href="GUIParameter.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_bottom");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+</script>
+</div>
+<a name="skip.navbar.bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
author	Eduardo Pedroni <ep625@york.ac.uk>	2014-05-06 14:29:37 +0100
committer	Eduardo Pedroni <ep625@york.ac.uk>	2014-05-06 14:29:37 +0100
commit	8189116ea4b5db4675e31dfd04a5687d55e29262 (patch)
tree	c1815021452a888f8838f1628d8fb4689777e73e /doc/jcgp/gui/settings/parameters/class-use/GUIParameter.html
parent	aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff)