From 6e2d004e22b56a8036dd7d56d98487c53eff6ee3 Mon Sep 17 00:00:00 2001 From: Rui Lopes Date: Thu, 15 Mar 2018 16:09:15 +0000 Subject: [PATCH] Updated documentation --- docs/allclasses-frame.html | 11 +- docs/allclasses-noframe.html | 11 +- docs/constant-values.html | 32 +++- docs/deprecated-list.html | 32 +++- docs/entities/Broker.html | 98 ++++++++---- docs/entities/BrokerState.html | 84 +++++++--- docs/entities/HorseJockey.html | 133 +++++++++++----- docs/entities/HorseJockeyState.html | 81 +++++++--- docs/entities/Spectator.html | 132 ++++++++++----- docs/entities/SpectatorState.html | 82 +++++++--- docs/entities/class-use/Broker.html | 36 ++++- docs/entities/class-use/BrokerState.html | 70 ++++++-- docs/entities/class-use/HorseJockey.html | 52 ++++-- docs/entities/class-use/HorseJockeyState.html | 70 ++++++-- docs/entities/class-use/Spectator.html | 64 ++++++-- docs/entities/class-use/SpectatorState.html | 70 ++++++-- docs/entities/package-frame.html | 11 +- docs/entities/package-summary.html | 94 ++++++----- docs/entities/package-tree.html | 52 ++++-- docs/entities/package-use.html | 63 ++++++-- docs/help-doc.html | 34 +++- docs/hippodrome/BettingCentre.html | 112 +++++++++---- docs/hippodrome/ControlCentre.html | 150 ++++++++++-------- .../GeneralInformationRepository.html | 44 ++++- docs/hippodrome/Paddock.html | 68 ++++++-- docs/hippodrome/RacingTrack.html | 81 +++++++--- docs/hippodrome/Stable.html | 68 ++++++-- docs/hippodrome/actions/Race.html | 61 +++++-- docs/hippodrome/actions/class-use/Race.html | 48 ++++-- docs/hippodrome/actions/package-frame.html | 11 +- docs/hippodrome/actions/package-summary.html | 69 +++++--- docs/hippodrome/actions/package-tree.html | 36 ++++- docs/hippodrome/actions/package-use.html | 44 ++++- docs/hippodrome/class-use/BettingCentre.html | 36 ++++- docs/hippodrome/class-use/ControlCentre.html | 36 ++++- .../GeneralInformationRepository.html | 36 ++++- docs/hippodrome/class-use/Paddock.html | 36 ++++- docs/hippodrome/class-use/RacingTrack.html | 36 ++++- docs/hippodrome/class-use/Stable.html | 36 ++++- docs/hippodrome/package-frame.html | 11 +- docs/hippodrome/package-summary.html | 98 +++++++----- docs/hippodrome/package-tree.html | 46 ++++-- docs/hippodrome/package-use.html | 32 +++- docs/index-files/index-1.html | 70 ++++++-- docs/index-files/index-10.html | 78 ++++----- docs/index-files/index-11.html | 96 ++++++----- docs/index-files/index-12.html | 127 ++++++++------- docs/index-files/index-13.html | 139 ++++++++++++++-- docs/index-files/index-14.html | 73 +++++---- docs/index-files/index-15.html | 74 +++++++-- docs/index-files/index-16.html | 4 +- docs/index-files/index-2.html | 44 ++++- docs/index-files/index-3.html | 48 +++++- docs/index-files/index-4.html | 40 ++++- docs/index-files/index-5.html | 48 ++++-- docs/index-files/index-6.html | 46 +++++- docs/index-files/index-7.html | 40 ++++- docs/index-files/index-8.html | 42 ++++- docs/index-files/index-9.html | 40 ++++- docs/index.html | 40 +++-- docs/member-search-index.js | 2 +- docs/member-search-index.zip | Bin 1147 -> 1212 bytes docs/overview-frame.html | 17 +- docs/overview-summary.html | 46 +++++- docs/overview-tree.html | 68 +++++--- docs/package-search-index.zip | Bin 214 -> 214 bytes docs/script.js | 145 ++++++++++++++++- docs/stage/Simulator.html | 47 +++++- docs/stage/class-use/Simulator.html | 36 ++++- docs/stage/package-frame.html | 11 +- docs/stage/package-summary.html | 81 ++++++---- docs/stage/package-tree.html | 36 ++++- docs/stage/package-use.html | 32 +++- docs/type-search-index.zip | Bin 330 -> 330 bytes entities/BrokerState.java | 2 +- entities/HorseJockeyState.java | 2 +- hippodrome/RacingTrack.java | 1 + 77 files changed, 3095 insertions(+), 987 deletions(-) diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html index c68b899..447d802 100644 --- a/docs/allclasses-frame.html +++ b/docs/allclasses-frame.html @@ -2,11 +2,20 @@ - + All Classes + + + + + + +

All Classes

diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html index bd71f93..fb5b5b2 100644 --- a/docs/allclasses-noframe.html +++ b/docs/allclasses-noframe.html @@ -2,11 +2,20 @@ - + All Classes + + + + + + +

All Classes

diff --git a/docs/constant-values.html b/docs/constant-values.html index 774889e..60368c1 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -2,11 +2,20 @@ - + Constant Field Values + + + + + + + +var pathtoroot = "./";loadScripts(document, 'script'); +
@@ -53,6 +63,12 @@ +
    +
  • SEARCH:  + + +
    • +
+
+
+
 
+

Constant Field Values

Contents

@@ -115,6 +140,9 @@

Contents

} //--> +
diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html index 45eaf63..7620b73 100644 --- a/docs/deprecated-list.html +++ b/docs/deprecated-list.html @@ -2,11 +2,20 @@ - + Deprecated List + + + + + + + +var pathtoroot = "./";loadScripts(document, 'script'); +
@@ -53,6 +63,12 @@ +
    +
  • SEARCH:  + + +
    • +
+
+
+
 
+

Deprecated API

Contents

@@ -115,6 +140,9 @@

Contents

} //--> +
diff --git a/docs/entities/Broker.html b/docs/entities/Broker.html index 0890a5a..e8d615a 100644 --- a/docs/entities/Broker.html +++ b/docs/entities/Broker.html @@ -2,11 +2,20 @@ - + Broker + + + + + + + +var pathtoroot = "../";loadScripts(document, 'script'); +
@@ -59,6 +69,12 @@ +
    +
  • SEARCH:  + + +
    • +
+
    @@ -90,9 +109,15 @@
+
+
 
+
-
entities
+
Package entities

Class Broker

@@ -114,7 +139,7 @@

Class Broker

  • All Implemented Interfaces:
    -
    java.lang.Runnable
    +
    java.lang.Runnable

    @@ -122,14 +147,14 @@

    Class Broker

    extends java.lang.Thread implements java.lang.Runnable
    Implementation of a Broker, an essential character on a horse race action. This - entity, belonging to the entities package, has the responsibility of + entity, belonging to the entities package, has the responsibility of controlling the races and of honouring and accepting the spectator's bets (for more information about the spectator, please, consult Spectator).
    Since:
    -
    1.0
    +
    0.1
    Version:
    -
    1.0
    +
    0.1
    Author:
    Hugo Fragata, Rui Lopes
    See Also:
    @@ -163,22 +188,25 @@

    Nested classes/interfaces inherited from class java.lang.Thread

    Field Summary

    - +
    - + + - + - + @@ -198,13 +226,17 @@

    Fields inherited from class java.lang.Thread

    Constructor Summary

    -
    Fields 
    Modifier and TypeField and DescriptionFieldDescription
    private BrokerStatestate +state
    A representation of the Broker's state given by the BrokerState enumeration.
    private inttotalOfRaces +totalOfRaces
    Broker's knowledge of how many races are about to be performed today.
    +
    - + + - + +
    Constructors 
    Constructor and DescriptionConstructorDescription
    Broker() Broker​() +
    Constructs a Broker.
    +
    • @@ -215,46 +247,50 @@

    Constructor Summary

    Method Summary

    - +
    - + + - + - + - +
    All Methods Instance Methods Concrete Methods 
    Modifier and TypeMethod and DescriptionMethodDescription
    BrokerStategetBrokerState() +getBrokerState​()
    Returns the Broker state representation given by the BrokerState enumeration.
    voidrun() +run​()
    Definition of the Broker's lifecycle.
    voidsetBrokerState(BrokerState state) +setBrokerState​(BrokerState state)
    Sets the Broker's state, from the possible available BrokerState enumeration.
      -
    • +
    • -

      Methods inherited from class java.lang.Thread

      -activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
      • +

      Methods inherited from class java.lang.Object

      +equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      -
    • +
    • -

      Methods inherited from class java.lang.Object

      -equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +

      Methods inherited from class java.lang.Thread

      +activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
    @@ -305,7 +341,8 @@

    Constructor Detail

    • Broker

      -
      public Broker()
      +
      public Broker​()
      +
      Constructs a Broker.
    @@ -322,7 +359,7 @@

    Method Detail