Skip to content

Commit 18b580b

Browse files
author
mgricken
committed
Fixed Javadoc errors in drjava module.
git-svn-id: file:///tmp/test-svn/trunk@4443 fe72c1cf-3628-48e9-8b72-1c46755d3cff
1 parent e4984e1 commit 18b580b

File tree

12 files changed

+43
-64
lines changed

12 files changed

+43
-64
lines changed

‎drjava/src/edu/rice/cs/drjava/model/AbstractDJDocument.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,10 @@
8686
* Of course, a readLock or writeLock on this must be acquired BEFOFE locking _reducedModel. This protocol
8787
* prevents any thread from seeing an inconsistent state in the middle of another thread's changes.
8888
*
89-
* @see edu.rice.cs.drjava.model.definitions.reduced.BraceReduction
90-
* @see edu.rice.cs.drjava.model.definitions.reduced.ReducedModelControl
91-
* @see edu.rice.cs.drjava.model.definitions.reduced.ReducedModelComment
92-
* @see edu.rice.cs.drjava.model.definitions.reduced.ReducedModelBrace
89+
* @see edu.rice.cs.drjava.model.definitions.reducedmodel.BraceReduction
90+
* @see edu.rice.cs.drjava.model.definitions.reducedmodel.ReducedModelControl
91+
* @see edu.rice.cs.drjava.model.definitions.reducedmodel.ReducedModelComment
92+
* @see edu.rice.cs.drjava.model.definitions.reducedmodel.ReducedModelBrace
9393
*/
9494
public abstract class AbstractDJDocument extends SwingDocument implements DJDocument, OptionConstants {
9595

‎drjava/src/edu/rice/cs/drjava/model/RegionManagerListener.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,11 @@
4545
public interface RegionManagerListener<R extends DocumentRegion> {
4646
/** Called when a region is added in a document. Must be executed in event thread.
4747
* @param r the region
48-
* @param index the index at which it was added
4948
*/
5049
public void regionAdded(R r);
5150

5251
/** Called when a region is changed. Must be executed in event thread.
5352
* @param r the region
54-
* @param index the index at which it was changed
5553
*/
5654
public void regionChanged(R r);
5755

‎drjava/src/edu/rice/cs/drjava/model/debug/DebugEventNotifier.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,6 @@ public void threadLocationUpdated(OpenDefinitionsDocument doc, int lineNumber,
109109

110110
/** Called when a breakpoint is set in a document. Must be executed in event thread.
111111
* @param bp the breakpoint
112-
* @param index the index at which it was added
113112
*/
114113
public void regionAdded(Breakpoint bp) {
115114
assert EventQueue.isDispatchThread();
@@ -140,7 +139,6 @@ public void breakpointReached(Breakpoint bp) {
140139

141140
/** Called when a breakpoint is changed during execution. Must be executed in event thread.
142141
* @param bp the breakpoint
143-
* @param index the index at which it was changed
144142
*/
145143
public void regionChanged(Breakpoint bp) {
146144
assert EventQueue.isDispatchThread();

‎drjava/src/edu/rice/cs/drjava/model/debug/DebugStackData.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ public class DebugStackData {
4646

4747
/**
4848
* Object for keeping track of a stack frame.
49-
* @param frame JPDA's reference to the stack frame
49+
* @param method name of the method
50+
* @param line line number in the file
5051
*/
5152
public DebugStackData(String method, int line) {
5253
_method = method;

‎drjava/src/edu/rice/cs/drjava/model/definitions/reducedmodel/IndentInfo.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public IndentInfo() {
7777
}
7878

7979
/** Creates an indent info with the specified parameters
80-
* @param enclosingBraceType the enclosingBraceType
80+
* @param lineEnclosingBraceType the enclosingBraceType
8181
* @param distToLineEnclosingBraceStart the distance to the next newline
8282
* @param distToLineEnclosingBrace the distance to a brace
8383
* @param distToStart the distance to the previous newline

‎drjava/src/edu/rice/cs/drjava/model/junit/DefaultJUnitModel.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@
6060
import edu.rice.cs.drjava.model.compiler.DummyCompilerListener;
6161
import edu.rice.cs.drjava.model.definitions.InvalidPackageException;
6262

63-
//import edu.rice.cs.util.ExitingNotAllowedException;
6463
import edu.rice.cs.plt.io.IOUtil;
6564
import edu.rice.cs.plt.lambda.Box;
6665
import edu.rice.cs.plt.lambda.SimpleBox;

‎drjava/src/edu/rice/cs/drjava/model/repl/InteractionsModel.java‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,12 +247,28 @@ public final void resetInterpreter(File wd) {
247247
public File getWorkingDirectory() { return _workingDirectory; }
248248

249249
/** These add the given path to the classpaths used in the interpreter.
250-
* @param file the path to add
250+
* @param f the path to add
251251
*/
252252
public abstract void addProjectClassPath(File f);
253+
254+
/** These add the given path to the build directory classpaths used in the interpreter.
255+
* @param f the path to add
256+
*/
253257
public abstract void addBuildDirectoryClassPath(File f);
258+
259+
/** These add the given path to the project files classpaths used in the interpreter.
260+
* @param f the path to add
261+
*/
254262
public abstract void addProjectFilesClassPath(File f);
263+
264+
/** These add the given path to the external files classpaths used in the interpreter.
265+
* @param f the path to add
266+
*/
255267
public abstract void addExternalFilesClassPath(File f);
268+
269+
/** These add the given path to the extra classpaths used in the interpreter.
270+
* @param f the path to add
271+
*/
256272
public abstract void addExtraClassPath(File f);
257273

258274
/** Handles a syntax error being returned from an interaction

‎drjava/src/edu/rice/cs/drjava/model/repl/RMIInteractionsModel.java‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,17 +94,32 @@ public String getVariableType(String var) {
9494
// _interpreterControl.addClassPath(path);
9595
// }
9696
//
97+
/** Adds the given path to the interpreter's classpath.
98+
* @param f the path to add
99+
*/
97100
public void addProjectClassPath(File f) { _jvm.addProjectClassPath(f); }
98101

102+
/** These add the given path to the build directory classpaths used in the interpreter.
103+
* @param f the path to add
104+
*/
99105
public void addBuildDirectoryClassPath(File f) { _jvm.addBuildDirectoryClassPath(f); }
100106

107+
/** These add the given path to the project files classpaths used in the interpreter.
108+
* @param f the path to add
109+
*/
101110
public void addProjectFilesClassPath(File f) {
102111
// System.err.println("Adding " + path + " to projectFilesClassPath in the slave JVM");
103112
_jvm.addProjectFilesClassPath(f);
104113
}
105114

115+
/** These add the given path to the external files classpaths used in the interpreter.
116+
* @param f the path to add
117+
*/
106118
public void addExternalFilesClassPath(File f) { _jvm.addExternalFilesClassPath(f); }
107119

120+
/** These add the given path to the extra classpaths used in the interpreter.
121+
* @param f the path to add
122+
*/
108123
public void addExtraClassPath(File f) { _jvm.addExtraClassPath(f); }
109124

110125
/** Resets the Java interpreter. */

‎drjava/src/edu/rice/cs/drjava/ui/FindResultsPanel.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ public class FindResultsPanel extends RegionsTreePanel<MovingDocumentRegion> {
104104
* @param searchString string that was searched for
105105
* @param searchAll whether all files were searched
106106
* @param doc weak reference to the document in which the search occurred (or started, if all documents were searched)
107-
* @param the FindReplacePanel that created this FindResultsPanel
107+
* @param findReplace the FindReplacePanel that created this FindResultsPanel
108108
*/
109109
public FindResultsPanel(MainFrame frame, RegionManager<MovingDocumentRegion> rm, String title,
110110
String searchString, boolean searchAll, final boolean matchCase,

‎drjava/src/edu/rice/cs/drjava/ui/MainFrame.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2398,7 +2398,7 @@ else if (startSel == endSel) {
23982398
* @param searchString string that was searched for
23992399
* @param searchAll whether all files were searched
24002400
* @param doc weak reference to the document in which the search occurred (or started, if all documents were searched)
2401-
* @param the FindReplacePanel that created this FindResultsPanel
2401+
* @param findReplace the FindReplacePanel that created this FindResultsPanel
24022402
*/
24032403
public FindResultsPanel createFindResultsPanel(final RegionManager<MovingDocumentRegion> rm, String title,
24042404
String searchString, boolean searchAll, boolean matchCase,

0 commit comments

Comments
 (0)