Skip to content

Commit

Permalink
updated javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
jlguida committed Nov 13, 2017
1 parent d68dbee commit 23a413d
Show file tree
Hide file tree
Showing 21 changed files with 114 additions and 56 deletions.
4 changes: 2 additions & 2 deletions javadoc/allclasses-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Nov 07 22:17:22 PST 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Sun Nov 12 16:20:13 PST 2017 -->
<title>All Classes</title>
<meta name="date" content="2017-11-07">
<meta name="date" content="2017-11-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions javadoc/allclasses-noframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Nov 07 22:17:22 PST 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Sun Nov 12 16:20:13 PST 2017 -->
<title>All Classes</title>
<meta name="date" content="2017-11-07">
<meta name="date" content="2017-11-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions javadoc/constant-values.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Nov 07 22:17:22 PST 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Sun Nov 12 16:20:13 PST 2017 -->
<title>Constant Field Values</title>
<meta name="date" content="2017-11-07">
<meta name="date" content="2017-11-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions javadoc/deprecated-list.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Nov 07 22:17:22 PST 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Sun Nov 12 16:20:13 PST 2017 -->
<title>Deprecated List</title>
<meta name="date" content="2017-11-07">
<meta name="date" content="2017-11-12">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Nov 07 22:17:22 PST 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Sun Nov 12 16:20:13 PST 2017 -->
<title>CustomOutputStream</title>
<meta name="date" content="2017-11-07">
<meta name="date" content="2017-11-12">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Nov 07 22:17:22 PST 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Sun Nov 12 16:20:13 PST 2017 -->
<title>InstallCert</title>
<meta name="date" content="2017-11-07">
<meta name="date" content="2017-11-12">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Nov 07 22:17:22 PST 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Sun Nov 12 16:20:13 PST 2017 -->
<title>SearchGui_Curriculum</title>
<meta name="date" content="2017-11-07">
<meta name="date" content="2017-11-12">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Nov 07 22:17:22 PST 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Sun Nov 12 16:20:13 PST 2017 -->
<title>UCSBCurriculumSearch</title>
<meta name="date" content="2017-11-07">
<meta name="date" content="2017-11-12">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
Expand All @@ -18,7 +18,7 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":10,"i14":10,"i15":10,"i16":9};
var methods = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":10,"i16":10,"i17":10,"i18":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -228,26 +228,38 @@ <h3>Method Summary</h3>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#findQuarterAndYear-java.lang.String-">findQuarterAndYear</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;html)</code>
<div class="block">Find the list of quarters that are viewable given the HTML</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#findSubjectAreas-java.lang.String-">findSubjectAreas</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;html)</code>
<div class="block">Find the list of offered Subject Areas given the HTML of the main page</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBLecture.html" title="class in edu.ucsb.cs56.projects.scrapers.ucsb_curriculum">UCSBLecture</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#getLecture-java.lang.String-java.lang.String-">getLecture</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;Title,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;quarter)</code>
<div class="block">return a UCSBLecture object given a course number and quarter</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a>&lt;<a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBLecture.html" title="class in edu.ucsb.cs56.projects.scrapers.ucsb_curriculum">UCSBLecture</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#getLectures--">getLectures</a></span>()</code>
<div class="block">return an ArrayList of UCSBLecture objects</div>
</td>
</tr>
<tr id="i6" class="altColor">
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#getMainPage--">getMainPage</a></span>()</code>
<div class="block">getMainPage() returns the contents of the main page at MAINPAGE_URL
as a String.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#getPage-java.lang.String-java.lang.String-java.lang.String-">getPage</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;dept,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;qtr,
Expand All @@ -256,28 +268,28 @@ <h3>Method Summary</h3>
for a given department, quarter, and level.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBSection.html" title="class in edu.ucsb.cs56.projects.scrapers.ucsb_curriculum">UCSBSection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#getSection-java.lang.String-">getSection</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;enrollCode)</code>
<div class="block">return a UCSBSection object given an enrollcode, if it doesn't exist,
return a null object</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBSection.html" title="class in edu.ucsb.cs56.projects.scrapers.ucsb_curriculum">UCSBSection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#getSection-java.lang.String-java.lang.String-">getSection</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;courseNum,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;quarter)</code>
<div class="block">return a UCSBSection object given a course number and quarter</div>
</td>
</tr>
<tr id="i10" class="altColor">
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a>&lt;<a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBSection.html" title="class in edu.ucsb.cs56.projects.scrapers.ucsb_curriculum">UCSBSection</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#getSections-java.lang.String-java.lang.String-">getSections</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;courseNum,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;quarter)</code>
<div class="block">return an ArrayList of UCSBSection objects given a course number and quarter</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<tr id="i13" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#loadCourses-java.lang.String-java.lang.String-java.lang.String-">loadCourses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;dept,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;qtr,
Expand All @@ -286,32 +298,32 @@ <h3>Method Summary</h3>
courses for a given Department, Quarter, and level.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<tr id="i14" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#main-java.lang.String:A-">main</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>
<div class="block">main method to demonstrate that the page is being accessed</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBLecture.html" title="class in edu.ucsb.cs56.projects.scrapers.ucsb_curriculum">UCSBLecture</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#parseLectureHtml-java.lang.String-">parseLectureHtml</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;html)</code>
<div class="block">Parses the HTML of a Lecture and returns a new UCSBLecture object</div>
</td>
</tr>
<tr id="i14" class="altColor">
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBSection.html" title="class in edu.ucsb.cs56.projects.scrapers.ucsb_curriculum">UCSBSection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#parseSectionHtml-java.lang.String-edu.ucsb.cs56.projects.scrapers.ucsb_curriculum.UCSBLecture-">parseSectionHtml</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;html,
<a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBLecture.html" title="class in edu.ucsb.cs56.projects.scrapers.ucsb_curriculum">UCSBLecture</a>&nbsp;parent)</code>
<div class="block">Parses the HTML of a Section and returns a new UCSBSection object</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#printLectures--">printLectures</a></span>()</code>
<div class="block">Prints lectures and subsquent section</div>
</td>
</tr>
<tr id="i16" class="altColor">
<tr id="i18" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../edu/ucsb/cs56/projects/scrapers/ucsb_curriculum/UCSBCurriculumSearch.html#qtrParse-java.lang.String-">qtrParse</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;qtr)</code>
<div class="block">Parses the quarter to the correct corresponding number that represents it.</div>
Expand Down Expand Up @@ -512,6 +524,38 @@ <h4>loadCourses</h4>
</dl>
</li>
</ul>
<a name="findSubjectAreas-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findSubjectAreas</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;findSubjectAreas(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;html)</pre>
<div class="block">Find the list of offered Subject Areas given the HTML of the main page</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>html</code> - HTML of the main url</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ArrayLIst of Strings of offered subject areas</dd>
</dl>
</li>
</ul>
<a name="findQuarterAndYear-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findQuarterAndYear</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;findQuarterAndYear(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;html)</pre>
<div class="block">Find the list of quarters that are viewable given the HTML</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>html</code> - HTML of the main URL</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ArrayList of Strings of quarters</dd>
</dl>
</li>
</ul>
<a name="parseLectureHtml-java.lang.String-">
<!-- -->
</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Nov 07 22:17:22 PST 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Sun Nov 12 16:20:13 PST 2017 -->
<title>UCSBCurriculumSearchTest</title>
<meta name="date" content="2017-11-07">
<meta name="date" content="2017-11-12">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Nov 07 22:17:22 PST 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Sun Nov 12 16:20:13 PST 2017 -->
<title>UCSBLecture</title>
<meta name="date" content="2017-11-07">
<meta name="date" content="2017-11-12">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Tue Nov 07 22:17:22 PST 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Sun Nov 12 16:20:13 PST 2017 -->
<title>UCSBLectureTest</title>
<meta name="date" content="2017-11-07">
<meta name="date" content="2017-11-12">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
Expand Down
Loading

0 comments on commit 23a413d

Please sign in to comment.