bumped documentation

This commit is contained in:
didier amyot committed 2023-12-05 16:41:42 -05:00
1 parent e2ecb3d49f
commit b366ff6879
1 file changed
+786
+786
View File
@@ -126,6 +126,94 @@
</div>
</li>
<li><a
href='#hockeyplayerstatistics'
class=" toggle-sibling">
HockeyPlayerStatistics
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#hockeyplayerstatisticsfirstname'
class='regular pre-open'>
#firstName
</a></li>
<li><a
href='#hockeyplayerstatisticslastname'
class='regular pre-open'>
#lastName
</a></li>
<li><a
href='#hockeyplayerstatisticsdateofbirth'
class='regular pre-open'>
#dateOfBirth
</a></li>
<li><a
href='#hockeyplayerstatisticssetnumberofplayedgames'
class='regular pre-open'>
#setNumberOfPlayedGames
</a></li>
<li><a
href='#hockeyplayerstatisticssetnumberofplayedplayoffgames'
class='regular pre-open'>
#setNumberOfPlayedPlayoffGames
</a></li>
<li><a
href='#hockeyplayerstatisticssetnumberofpointsduringplayoffgames'
class='regular pre-open'>
#setNumberOfPointsDuringPlayoffGames
</a></li>
<li><a
href='#hockeyplayerstatisticssetnumberofpoints'
class='regular pre-open'>
#setNumberOfPoints
</a></li>
<li><a
href='#hockeyplayerstatisticssetnumberofgoals'
class='regular pre-open'>
#setNumberOfGoals
</a></li>
<li><a
href='#hockeyplayerstatisticspointspergame'
class='regular pre-open'>
#pointsPerGame
</a></li>
<li><a
href='#hockeyplayerstatisticspointsperplayoffgame'
class='regular pre-open'>
#pointsPerPlayoffGame
</a></li>
<li><a
href='#hockeyplayerstatisticsgoalbyplayedgame'
class='regular pre-open'>
#goalByPlayedGame
</a></li>
</ul>
</div> </div>
</li> </li>
@@ -820,6 +908,704 @@ has a name (first and last) and a date of birth.</p>
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='hockeyplayerstatistics'>
HockeyPlayerStatistics
</h3>
</div>
<p>Class representing a simple hockey player with some statistics attached to it.</p>
<div class='pre p1 fill-light mt0'>new HockeyPlayerStatistics(firstName: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>, lastName: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>, dateOfBirth: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>firstName</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
the first name of the player
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>lastName</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">String</a>)</code>
the last name of the player
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>dateOfBirth</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a>)</code>
the birth date of the player
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Instance Members</div>
<div class="clearfix">
<div class='border-bottom' id='hockeyplayerstatisticsfirstname'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>firstName</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>the fist name of the player.</p>
<div class='pre p1 fill-light mt0'>firstName</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayerstatisticslastname'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>lastName</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>the last name of the player.</p>
<div class='pre p1 fill-light mt0'>lastName</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayerstatisticsdateofbirth'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>dateOfBirth</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>the date of birth of the player.</p>
<div class='pre p1 fill-light mt0'>dateOfBirth</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayerstatisticssetnumberofplayedgames'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>setNumberOfPlayedGames(numberOfPlayedGames)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Set the total number the player has played</p>
<div class='pre p1 fill-light mt0'>setNumberOfPlayedGames(numberOfPlayedGames: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>numberOfPlayedGames</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayerstatisticssetnumberofplayedplayoffgames'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>setNumberOfPlayedPlayoffGames(numberOfPlayedPlayoffGames)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Set the total number the player has played in playoff</p>
<div class='pre p1 fill-light mt0'>setNumberOfPlayedPlayoffGames(numberOfPlayedPlayoffGames: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>numberOfPlayedPlayoffGames</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayerstatisticssetnumberofpointsduringplayoffgames'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>setNumberOfPointsDuringPlayoffGames(numberOfPointsDuringPlayoffGames)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Set the total number the points the player has scored during playoff games.</p>
<div class='pre p1 fill-light mt0'>setNumberOfPointsDuringPlayoffGames(numberOfPointsDuringPlayoffGames: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>numberOfPointsDuringPlayoffGames</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayerstatisticssetnumberofpoints'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>setNumberOfPoints(numberOfPoints)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Set the total number the player has played</p>
<div class='pre p1 fill-light mt0'>setNumberOfPoints(numberOfPoints: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>numberOfPoints</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayerstatisticssetnumberofgoals'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>setNumberOfGoals(goals)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Set the total number of goal scored by the player</p>
<div class='pre p1 fill-light mt0'>setNumberOfGoals(goals: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>goals</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayerstatisticspointspergame'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>pointsPerGame</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>the number of points scored by game. This method requires
the knowledge of numberOfPoints and numberOfPlayedGames to
return a meaningful result.</p>
<div class='pre p1 fill-light mt0'>pointsPerGame</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayerstatisticspointsperplayoffgame'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>pointsPerPlayoffGame</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>the number of points scored by playoff game. This method requires
the knowledge of numberOfPointsDuringPlayoffGames and
numberOfPlayedPlayoffGames to return a meaningful result.</p>
<div class='pre p1 fill-light mt0'>pointsPerPlayoffGame</div>
</section>
</div>
</div>
<div class='border-bottom' id='hockeyplayerstatisticsgoalbyplayedgame'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>goalByPlayedGame</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>the number of goals scored by game. This method requires
the knowledge of numberOfGoals and numberOfPlayedGames to
return a meaningful result.</p>
<div class='pre p1 fill-light mt0'>goalByPlayedGame</div>