From aabc65b57d1f91eeaa96e46e52d874a3c9faee1a Mon Sep 17 00:00:00 2001
From: yausername <13ritvik@gmail.com>
Date: Sat, 23 Mar 2019 19:11:51 +0530
Subject: [PATCH] added java doc for stream

---
 .../newpipe/extractor/stream/Stream.java      | 33 +++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/stream/Stream.java b/extractor/src/main/java/org/schabi/newpipe/extractor/stream/Stream.java
index 865cde0cc..173534474 100644
--- a/extractor/src/main/java/org/schabi/newpipe/extractor/stream/Stream.java
+++ b/extractor/src/main/java/org/schabi/newpipe/extractor/stream/Stream.java
@@ -16,10 +16,23 @@ public abstract class Stream implements Serializable {
     @Deprecated
     public final int format;
 
+    /**
+     * Instantiates a new stream object.
+     *
+     * @param url the url
+     * @param format the format
+     */
     public Stream(String url, MediaFormat format) {
         this(url, null, format);
     }
     
+    /**
+     * Instantiates a new stream object.
+     *
+     * @param url the url
+     * @param torrentUrl the url to torrent file, example https://webtorrent.io/torrents/big-buck-bunny.torrent
+     * @param format the format
+     */
     public Stream(String url, String torrentUrl, MediaFormat format) {
         this.url = url;
         this.torrentUrl = torrentUrl;
@@ -52,18 +65,38 @@ public abstract class Stream implements Serializable {
         return false;
     }
 
+    /**
+     * Gets the url.
+     *
+     * @return the url
+     */
     public String getUrl() {
         return url;
     }
     
+    /**
+     * Gets the torrent url.
+     *
+     * @return the torrent url, example https://webtorrent.io/torrents/big-buck-bunny.torrent
+     */
     public String getTorrentUrl() {
         return torrentUrl;
     }
 
+    /**
+     * Gets the format.
+     *
+     * @return the format
+     */
     public MediaFormat getFormat() {
         return mediaFormat;
     }
 
+    /**
+     * Gets the format id.
+     *
+     * @return the format id
+     */
     public int getFormatId() {
         return mediaFormat.id;
     }