Fixed Javadoc issues

bThink-BGU · Oct 17, 2018 · aa08b6d · aa08b6d
1 parent 76418f6
commit aa08b6d
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -45,6 +45,7 @@ a link to this page somewhere in the documentation/system about section.
 
 ### 2018-10-17
 * :sparkles: `BProgramRunner` now has a `halt()` method #53.
+* :sparkles: Documentation now covering verification (well, the basics).
 * :sparkles: A b-progrm's logging level can be set from Java (#50)
 * :put_litter_in_its_place: Removed old exception code. More tests.
 * :put_litter_in_its_place: `bsync`, deprecated long ago, was removed.

diff --git a/src/main/java/il/ac/bgu/cs/bp/bpjs/execution/jsproxy/BThreadJsProxy.java b/src/main/java/il/ac/bgu/cs/bp/bpjs/execution/jsproxy/BThreadJsProxy.java
@@ -4,36 +4,13 @@
 package il.ac.bgu.cs.bp.bpjs.execution.jsproxy;
 
 import il.ac.bgu.cs.bp.bpjs.model.BThreadSyncSnapshot;
-import il.ac.bgu.cs.bp.bpjs.model.BSyncStatement;
-import il.ac.bgu.cs.bp.bpjs.model.BEvent;
-import il.ac.bgu.cs.bp.bpjs.model.eventsets.ComposableEventSet;
-import il.ac.bgu.cs.bp.bpjs.model.eventsets.EventSet;
-import il.ac.bgu.cs.bp.bpjs.model.eventsets.EventSets;
-import java.util.Arrays;
-import java.util.Map;
 import java.util.Objects;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-import static java.util.stream.Collectors.toList;
-import static java.util.stream.Collectors.toSet;
-import java.util.stream.Stream;
-import org.mozilla.javascript.Context;
-import org.mozilla.javascript.ContinuationPending;
 import org.mozilla.javascript.Function;
-import org.mozilla.javascript.NativeArray;
-import org.mozilla.javascript.NativeObject;
 
 /**
  * Serves as {@code this} (of sorts) for Javascript BThread code. Public methods
  * in this class are directly callable form BThread code, no qualification needed.
  * 
- * For example, the following code invokes {@link #bsync(org.mozilla.javascript.NativeObject) }:
- * 
- * <pre><code>
- * bp.registerBThread( function(){
- *   bsync(...);
- * });
- * </code></pre>
  * @author michael
  */
 public class BThreadJsProxy implements java.io.Serializable {

diff --git a/src/main/java/il/ac/bgu/cs/bp/bpjs/execution/jsproxy/BpLog.java b/src/main/java/il/ac/bgu/cs/bp/bpjs/execution/jsproxy/BpLog.java
@@ -23,6 +23,8 @@
  */
 package il.ac.bgu.cs.bp.bpjs.execution.jsproxy;
 
+import il.ac.bgu.cs.bp.bpjs.model.BProgram;
+
 /**
  * Simple logging mechanism for {@link BProgram}s.
  * 

diff --git a/src/main/java/il/ac/bgu/cs/bp/bpjs/execution/listeners/BProgramRunnerListener.java b/src/main/java/il/ac/bgu/cs/bp/bpjs/execution/listeners/BProgramRunnerListener.java
@@ -32,7 +32,7 @@ public interface BProgramRunnerListener {
      * 
      * @param bp The BProgram informing the change.
      * 
-     * @see BProgram#setDaemonMode(boolean) 
+     * @see BProgram#setWaitForExternalEvents(boolean)
      */
     void superstepDone( BProgram bp );
 

diff --git a/src/main/java/il/ac/bgu/cs/bp/bpjs/model/BProgram.java b/src/main/java/il/ac/bgu/cs/bp/bpjs/model/BProgram.java
@@ -388,7 +388,7 @@ public void setWaitForExternalEvents(boolean shouldWait) {
      *
      * @return {@code true} if this BProgram waits for external events,
      * {@code false} otherwise.
-     * @see #enqueueExternalEvent(il.ac.bgu.cs.bp.bpjs.events.BEvent)
+     * @see #enqueueExternalEvent(il.ac.bgu.cs.bp.bpjs.model.BEvent) 
      */
     public boolean isWaitForExternalEvents() {
         return waitForExternalEvents;