Skip to content

Commit

Permalink
Clean up javadoc problems
Browse files Browse the repository at this point in the history
  • Loading branch information
pwoodworth committed Jul 30, 2013
1 parent bf4d679 commit 5a499ce
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 14 deletions.
6 changes: 3 additions & 3 deletions src/main/java/com/turn/ttorrent/client/Client.java
Original file line number Diff line number Diff line change
Expand Up @@ -941,11 +941,11 @@ public void handleIOException(SharingPeer peer, IOException ioe) {
* <p>
* When the download is complete, the client switches to seeding mode for
* as long as requested in the <code>share()</code> call, if seeding was
* requested. If not, the StopSeedingTask will execute immediately to stop
* the client's main loop.
* requested. If not, the {@link ClientShutdown} will execute
* immediately to stop the client's main loop.
* </p>
*
* @see StopSeedingTask
* @see ClientShutdown
*/
private synchronized void seed() {
// Silently ignore if we're already seeding.
Expand Down
2 changes: 0 additions & 2 deletions src/main/java/com/turn/ttorrent/client/SharedTorrent.java
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,6 @@ public SharedTorrent(byte[] torrent, File destDir)
* destination directory does not exist and can't be created.
* @throws IOException If the torrent file cannot be read or decoded.
* @throws NoSuchAlgorithmException
* @throws URISyntaxException When one of the defined tracker addresses is
* invalid.
*/
public SharedTorrent(byte[] torrent, File parent, boolean seeder)
throws FileNotFoundException, IOException, NoSuchAlgorithmException {
Expand Down
2 changes: 0 additions & 2 deletions src/main/java/com/turn/ttorrent/client/announce/Announce.java
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,6 @@ public class Announce implements Runnable {
*
* @param torrent The torrent we're announcing about.
* @param peer Our peer specification.
* @param type A string representing the announce type (used in the thread
* name).
*/
public Announce(SharedTorrent torrent, Peer peer) {
this.peer = peer;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public abstract void announce(AnnounceRequestMessage.RequestEvent event,
* Close any opened announce connection.
*
* <p>
* This method is called by {@link #stop()} to make sure all connections
* This method is called by {@link Announce#stop()} to make sure all connections
* are correctly closed when the announce thread is asked to stop.
* </p>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ public void announce(AnnounceRequestMessage.RequestEvent event,
*
* <p>
* Verifies the transaction ID of the message before passing it over to
* {@link Announce#handleTrackerAnnounceResponse()}.
* any registered {@link AnnounceResponseListener}.
* </p>
*
* @param message The message received from the tracker in response to the
Expand Down Expand Up @@ -352,7 +352,7 @@ private void send(ByteBuffer data) {
*
* @param attempt The attempt number, used to calculate the timeout for the
* receive operation.
* @retun Returns a {@link ByteBuffer} containing the packet data.
* @return Returns a {@link ByteBuffer} containing the packet data.
*/
private ByteBuffer recv(int attempt)
throws IOException, SocketException, SocketTimeoutException {
Expand Down
3 changes: 1 addition & 2 deletions src/main/java/com/turn/ttorrent/common/Torrent.java
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,6 @@ public TorrentFile(File file, long size) {
* BitTorrent specification) and create a Torrent object from it.
*
* @param torrent The meta-info byte data.
* @param parent The parent directory or location of the torrent files.
* @param seeder Whether we'll be seeding for this torrent or not.
* @throws IOException When the info dictionary can't be read or
* encoded and hashed back to create the torrent's SHA-1 hash.
Expand Down Expand Up @@ -592,7 +591,7 @@ public static Torrent create(File source, List<List<URI>> announceList,
* considering we'll be a full initial seeder for it.
* </p>
*
* @param parent The parent directory or location of the torrent files,
* @param source The parent directory or location of the torrent files,
* also used as the torrent's name.
* @param files The files to add into this torrent.
* @param announceList The announce URIs organized as tiers that will
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/turn/ttorrent/tracker/TrackerService.java
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ private void process(Request request, Response response,
* Tracker HTTP protocol.
* </p>
*
* @param uri The request's full URI, including query parameters.
* @param request The request's full URI, including query parameters.
* @return The {@link AnnounceRequestMessage} representing the client's
* announce request.
*/
Expand Down Expand Up @@ -350,7 +350,7 @@ private void serveError(Response response, OutputStream body,
* @param response The HTTP response object.
* @param body The response output stream to write to.
* @param status The HTTP status code to return.
* @param error The failure reason reported by the tracker.
* @param reason The failure reason reported by the tracker.
*/
private void serveError(Response response, OutputStream body,
Status status, ErrorMessage.FailureReason reason) throws IOException {
Expand Down

0 comments on commit 5a499ce

Please sign in to comment.