From 7c23f453d166d396451504e26fbb385afc0c4c13 Mon Sep 17 00:00:00 2001
From: Clyhtsuriva <aimeric@adjutor.xyz>
Date: Mon, 28 Dec 2020 17:31:33 +0100
Subject: Finishing javadoc
---
javadoc/MusicalElement.html | 94 +++++++++++++++++++++++++++++++++++++--------
1 file changed, 79 insertions(+), 15 deletions(-)
(limited to 'javadoc/MusicalElement.html')
diff --git a/javadoc/MusicalElement.html b/javadoc/MusicalElement.html
index fa4e8c3..e1262dc 100644
--- a/javadoc/MusicalElement.html
+++ b/javadoc/MusicalElement.html
@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="fr">
<head>
-<!-- Generated by javadoc (1.8.0_272) on Mon Dec 28 15:55:07 CET 2020 -->
+<!-- Generated by javadoc (1.8.0_272) on Mon Dec 28 17:30:46 CET 2020 -->
<title>MusicalElement</title>
<meta name="date" content="2020-12-28">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -118,13 +118,12 @@ var activeTableTab = "activeTableTab";
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">The MusicalElement contains the base of songs and audiobooks.
- It is the abstract class they will take.
- We use the classical get and set here.
- Get is used to return the said value.
- Set is used to modify the later.</div>
+ It's the abstract class they will extend.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
-<dd><a href="serialized-form.html#MusicalElement">Serialized Form</a></dd>
+<dd><a href="Song.html" title="class in <Unnamed>"><code>Song</code></a>,
+<a href="AudioBook.html" title="class in <Unnamed>"><code>AudioBook</code></a>,
+<a href="serialized-form.html#MusicalElement">Serialized Form</a></dd>
</dl>
</li>
</ul>
@@ -146,7 +145,9 @@ implements java.io.Serializable</pre>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="MusicalElement.html#MusicalElement-java.lang.String-int-java.lang.String-">MusicalElement</a></span>(java.lang.String title,
int duration,
- java.lang.String content)</code> </td>
+ java.lang.String content)</code>
+<div class="block">Constructor method.</div>
+</td>
</tr>
</table>
</li>
@@ -165,35 +166,51 @@ implements java.io.Serializable</pre>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getContent--">getContent</a></span>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getContent--">getContent</a></span>()</code>
+<div class="block">This method is used to give the content path of the element.</div>
+</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getDuration--">getDuration</a></span>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getDuration--">getDuration</a></span>()</code>
+<div class="block">This method is used to give the duration of the element.</div>
+</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getId--">getId</a></span>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getId--">getId</a></span>()</code>
+<div class="block">This method is used to give the id of the element.</div>
+</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getTitle--">getTitle</a></span>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#getTitle--">getTitle</a></span>()</code>
+<div class="block">This method is used to give the title of the element.</div>
+</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setContent-java.lang.String-">setContent</a></span>(java.lang.String content)</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setContent-java.lang.String-">setContent</a></span>(java.lang.String content)</code>
+<div class="block">Basic method to set the content path of the element.</div>
+</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setDuration-int-">setDuration</a></span>(int duration)</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setDuration-int-">setDuration</a></span>(int duration)</code>
+<div class="block">Basic method to set the duration of the element.</div>
+</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setId-int-">setId</a></span>(int id)</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setId-int-">setId</a></span>(int id)</code>
+<div class="block">Basic method to set the id of the element.</div>
+</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setTitle-java.lang.String-">setTitle</a></span>(java.lang.String title)</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="MusicalElement.html#setTitle-java.lang.String-">setTitle</a></span>(java.lang.String title)</code>
+<div class="block">Basic method to set the title of the element.</div>
+</td>
</tr>
</table>
<ul class="blockList">
@@ -226,6 +243,13 @@ implements java.io.Serializable</pre>
<pre>public MusicalElement(java.lang.String title,
int duration,
java.lang.String content)</pre>
+<div class="block">Constructor method.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>title</code> - String</dd>
+<dd><code>duration</code> - int</dd>
+<dd><code>content</code> - String, path to the mp3 file</dd>
+</dl>
</li>
</ul>
</li>
@@ -243,6 +267,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getId</h4>
<pre>public int getId()</pre>
+<div class="block">This method is used to give the id of the element.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>id int</dd>
+</dl>
</li>
</ul>
<a name="getTitle--">
@@ -252,6 +281,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getTitle</h4>
<pre>public java.lang.String getTitle()</pre>
+<div class="block">This method is used to give the title of the element.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>title String</dd>
+</dl>
</li>
</ul>
<a name="getDuration--">
@@ -261,6 +295,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getDuration</h4>
<pre>public int getDuration()</pre>
+<div class="block">This method is used to give the duration of the element.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>duration int</dd>
+</dl>
</li>
</ul>
<a name="getContent--">
@@ -270,6 +309,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>getContent</h4>
<pre>public java.lang.String getContent()</pre>
+<div class="block">This method is used to give the content path of the element.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>content String</dd>
+</dl>
</li>
</ul>
<a name="setId-int-">
@@ -279,6 +323,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>setId</h4>
<pre>public void setId(int id)</pre>
+<div class="block">Basic method to set the id of the element.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>id</code> - int</dd>
+</dl>
</li>
</ul>
<a name="setTitle-java.lang.String-">
@@ -288,6 +337,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>setTitle</h4>
<pre>public void setTitle(java.lang.String title)</pre>
+<div class="block">Basic method to set the title of the element.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>title</code> - String</dd>
+</dl>
</li>
</ul>
<a name="setDuration-int-">
@@ -297,6 +351,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>setDuration</h4>
<pre>public void setDuration(int duration)</pre>
+<div class="block">Basic method to set the duration of the element.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>duration</code> - int</dd>
+</dl>
</li>
</ul>
<a name="setContent-java.lang.String-">
@@ -306,6 +365,11 @@ implements java.io.Serializable</pre>
<li class="blockList">
<h4>setContent</h4>
<pre>public void setContent(java.lang.String content)</pre>
+<div class="block">Basic method to set the content path of the element.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>content</code> - String</dd>
+</dl>
</li>
</ul>
</li>
--
cgit v1.2.3