Java Docs update

techgnious · Oct 14, 2020 · ba343a6 · ba343a6
1 parent 9949c39
commit ba343a6
Show file tree

Hide file tree

Showing 68 changed files with 1,956 additions and 457 deletions.
diff --git a/.settings/org.eclipse.jdt.core.prefs b/.settings/org.eclipse.jdt.core.prefs
@@ -1,8 +1,8 @@
 eclipse.preferences.version=1
 org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
-org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5
 org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
-org.eclipse.jdt.core.compiler.compliance=1.8
+org.eclipse.jdt.core.compiler.compliance=1.5
 org.eclipse.jdt.core.compiler.debug.lineNumber=generate
 org.eclipse.jdt.core.compiler.debug.localVariable=generate
 org.eclipse.jdt.core.compiler.debug.sourceFile=generate
@@ -13,4 +13,4 @@ org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning
 org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=ignore
 org.eclipse.jdt.core.compiler.processAnnotations=disabled
 org.eclipse.jdt.core.compiler.release=disabled
-org.eclipse.jdt.core.compiler.source=1.8
+org.eclipse.jdt.core.compiler.source=1.5
diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_221) on Mon Oct 05 17:42:22 IST 2020 -->
+<!-- Generated by javadoc (1.8.0_221) on Wed Oct 14 11:16:25 IST 2020 -->
 <title>All Classes</title>
-<meta name="date" content="2020-10-05">
+<meta name="date" content="2020-10-14">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_221) on Mon Oct 05 17:42:22 IST 2020 -->
+<!-- Generated by javadoc (1.8.0_221) on Wed Oct 14 11:16:25 IST 2020 -->
 <title>All Classes</title>
-<meta name="date" content="2020-10-05">
+<meta name="date" content="2020-10-14">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/doc/constant-values.html b/doc/constant-values.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_221) on Mon Oct 05 17:42:22 IST 2020 -->
+<!-- Generated by javadoc (1.8.0_221) on Wed Oct 14 11:16:25 IST 2020 -->
 <title>Constant Field Values</title>
-<meta name="date" content="2020-10-05">
+<meta name="date" content="2020-10-14">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_221) on Mon Oct 05 17:42:22 IST 2020 -->
+<!-- Generated by javadoc (1.8.0_221) on Wed Oct 14 11:16:25 IST 2020 -->
 <title>Deprecated List</title>
-<meta name="date" content="2020-10-05">
+<meta name="date" content="2020-10-14">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/doc/help-doc.html b/doc/help-doc.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_221) on Mon Oct 05 17:42:22 IST 2020 -->
+<!-- Generated by javadoc (1.8.0_221) on Wed Oct 14 11:16:25 IST 2020 -->
 <title>API Help</title>
-<meta name="date" content="2020-10-05">
+<meta name="date" content="2020-10-14">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/doc/index-files/index-1.html b/doc/index-files/index-1.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_221) on Mon Oct 05 17:42:22 IST 2020 -->
-<title>E-Index</title>
-<meta name="date" content="2020-10-05">
+<!-- Generated by javadoc (1.8.0_221) on Wed Oct 14 11:16:25 IST 2020 -->
+<title>C-Index</title>
+<meta name="date" content="2020-10-14">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="E-Index";
+            parent.document.title="C-Index";
         }
     }
     catch(err) {
@@ -68,23 +68,22 @@
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
-<div class="contentContainer"><a href="index-1.html">E</a>&nbsp;<a href="index-2.html">I</a>&nbsp;<a href="index-3.html">R</a>&nbsp;<a name="I:E">
+<div class="contentContainer"><a href="index-1.html">C</a>&nbsp;<a href="index-2.html">E</a>&nbsp;<a href="index-3.html">I</a>&nbsp;<a href="index-4.html">R</a>&nbsp;<a name="I:C">
 <!--   -->
 </a>
-<h2 class="title">E</h2>
+<h2 class="title">C</h2>
 <dl>
-<dt><span class="memberNameLink"><a href="../io/github/techgnious/IVCompressor.html#encodeVideoWithAttributes-byte:A-io.github.techgnious.dto.VideoFormats-io.github.techgnious.dto.IVAudioAttributes-io.github.techgnious.dto.IVVideoAttributes-">encodeVideoWithAttributes(byte[], VideoFormats, IVAudioAttributes, IVVideoAttributes)</a></span> - Method in class io.github.techgnious.<a href="../io/github/techgnious/IVCompressor.html" title="class in io.github.techgnious">IVCompressor</a></dt>
+<dt><span class="memberNameLink"><a href="../io/github/techgnious/IVCompressor.html#convertAndResizeVideo-byte:A-io.github.techgnious.dto.VideoFormats-io.github.techgnious.dto.VideoFormats-io.github.techgnious.dto.ResizeResolution-">convertAndResizeVideo(byte[], VideoFormats, VideoFormats, ResizeResolution)</a></span> - Method in class io.github.techgnious.<a href="../io/github/techgnious/IVCompressor.html" title="class in io.github.techgnious">IVCompressor</a></dt>
 <dd>
-<div class="block">This method helps in converting the video content to reduced size with lower
- resolution with user defined attributes
-
- Encodes the video with custom attributes thereby reducing the size of the
- video with better quality
-
- Maintains the best compressed quality</div>
+<div class="block">This method helps in converting the video to another format.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="../io/github/techgnious/IVCompressor.html#convertVideoFormat-byte:A-io.github.techgnious.dto.VideoFormats-io.github.techgnious.dto.VideoFormats-">convertVideoFormat(byte[], VideoFormats, VideoFormats)</a></span> - Method in class io.github.techgnious.<a href="../io/github/techgnious/IVCompressor.html" title="class in io.github.techgnious">IVCompressor</a></dt>
+<dd>
+<div class="block">This method is used to convert the video from existing format to another
+ format without compressing the data</div>
 </dd>
 </dl>
-<a href="index-1.html">E</a>&nbsp;<a href="index-2.html">I</a>&nbsp;<a href="index-3.html">R</a>&nbsp;</div>
+<a href="index-1.html">C</a>&nbsp;<a href="index-2.html">E</a>&nbsp;<a href="index-3.html">I</a>&nbsp;<a href="index-4.html">R</a>&nbsp;</div>
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->

diff --git a/doc/index-files/index-10.html b/doc/index-files/index-10.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_221) on Mon Oct 05 17:35:26 IST 2020 -->
+<!-- Generated by javadoc (1.8.0_221) on Wed Oct 14 11:14:17 IST 2020 -->
 <title>V-Index</title>
-<meta name="date" content="2020-10-05">
+<meta name="date" content="2020-10-14">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
 </head>
@@ -78,6 +78,10 @@ <h2 class="title">V</h2>
 <dd>
 <div class="block">Returns the enum constant of this type with the specified name.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="../io/github/techgnious/dto/ResizeResolution.html#valueOf-java.lang.String-">valueOf(String)</a></span> - Static method in enum io.github.techgnious.dto.<a href="../io/github/techgnious/dto/ResizeResolution.html" title="enum in io.github.techgnious.dto">ResizeResolution</a></dt>
+<dd>
+<div class="block">Returns the enum constant of this type with the specified name.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="../io/github/techgnious/dto/VideoFormats.html#valueOf-java.lang.String-">valueOf(String)</a></span> - Static method in enum io.github.techgnious.dto.<a href="../io/github/techgnious/dto/VideoFormats.html" title="enum in io.github.techgnious.dto">VideoFormats</a></dt>
 <dd>
 <div class="block">Returns the enum constant of this type with the specified name.</div>
@@ -87,6 +91,11 @@ <h2 class="title">V</h2>
 <div class="block">Returns an array containing the constants of this enum type, in
 the order they are declared.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="../io/github/techgnious/dto/ResizeResolution.html#values--">values()</a></span> - Static method in enum io.github.techgnious.dto.<a href="../io/github/techgnious/dto/ResizeResolution.html" title="enum in io.github.techgnious.dto">ResizeResolution</a></dt>
+<dd>
+<div class="block">Returns an array containing the constants of this enum type, in
+the order they are declared.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="../io/github/techgnious/dto/VideoFormats.html#values--">values()</a></span> - Static method in enum io.github.techgnious.dto.<a href="../io/github/techgnious/dto/VideoFormats.html" title="enum in io.github.techgnious.dto">VideoFormats</a></dt>
 <dd>
 <div class="block">Returns an array containing the constants of this enum type, in
@@ -95,17 +104,25 @@ <h2 class="title">V</h2>
 <dt><span class="memberNameLink"><a href="../io/github/techgnious/constants/IVConstants.html#VIDEO_CODEC">VIDEO_CODEC</a></span> - Static variable in class io.github.techgnious.constants.<a href="../io/github/techgnious/constants/IVConstants.html" title="class in io.github.techgnious.constants">IVConstants</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="../io/github/techgnious/exception/VideoException.html" title="class in io.github.techgnious.exception"><span class="typeNameLink">VideoException</span></a> - Exception in <a href="../io/github/techgnious/exception/package-summary.html">io.github.techgnious.exception</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Exception class to handle errors thrown during video compression</div>
+</dd>
 <dt><span class="memberNameLink"><a href="../io/github/techgnious/exception/VideoException.html#VideoException--">VideoException()</a></span> - Constructor for exception io.github.techgnious.exception.<a href="../io/github/techgnious/exception/VideoException.html" title="class in io.github.techgnious.exception">VideoException</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="../io/github/techgnious/exception/VideoException.html#VideoException-java.lang.String-java.lang.Throwable-">VideoException(String, Throwable)</a></span> - Constructor for exception io.github.techgnious.exception.<a href="../io/github/techgnious/exception/VideoException.html" title="class in io.github.techgnious.exception">VideoException</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Throws Video Exception error with custom message and casue</div>
+</dd>
 <dt><span class="memberNameLink"><a href="../io/github/techgnious/exception/VideoException.html#VideoException-java.lang.String-">VideoException(String)</a></span> - Constructor for exception io.github.techgnious.exception.<a href="../io/github/techgnious/exception/VideoException.html" title="class in io.github.techgnious.exception">VideoException</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Throws Video Exception error with custom message</div>
+</dd>
 <dt><span class="memberNameLink"><a href="../io/github/techgnious/exception/VideoException.html#VideoException-java.lang.Throwable-">VideoException(Throwable)</a></span> - Constructor for exception io.github.techgnious.exception.<a href="../io/github/techgnious/exception/VideoException.html" title="class in io.github.techgnious.exception">VideoException</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="../io/github/techgnious/dto/VideoFormats.html" title="enum in io.github.techgnious.dto"><span class="typeNameLink">VideoFormats</span></a> - Enum in <a href="../io/github/techgnious/dto/package-summary.html">io.github.techgnious.dto</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Enum Class that defines the type of video formats allowed</div>
+</dd>
 </dl>
 <a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">E</a>&nbsp;<a href="index-5.html">G</a>&nbsp;<a href="index-6.html">I</a>&nbsp;<a href="index-7.html">R</a>&nbsp;<a href="index-8.html">S</a>&nbsp;<a href="index-9.html">T</a>&nbsp;<a href="index-10.html">V</a>&nbsp;</div>
 <!-- ======= START OF BOTTOM NAVBAR ====== -->

diff --git a/doc/index-files/index-2.html b/doc/index-files/index-2.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_221) on Mon Oct 05 17:42:22 IST 2020 -->
-<title>I-Index</title>
-<meta name="date" content="2020-10-05">
+<!-- Generated by javadoc (1.8.0_221) on Wed Oct 14 11:16:25 IST 2020 -->
+<title>E-Index</title>
+<meta name="date" content="2020-10-14">
 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
 <script type="text/javascript" src="../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="I-Index";
+            parent.document.title="E-Index";
         }
     }
     catch(err) {
@@ -68,27 +68,23 @@
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
-<div class="contentContainer"><a href="index-1.html">E</a>&nbsp;<a href="index-2.html">I</a>&nbsp;<a href="index-3.html">R</a>&nbsp;<a name="I:I">
+<div class="contentContainer"><a href="index-1.html">C</a>&nbsp;<a href="index-2.html">E</a>&nbsp;<a href="index-3.html">I</a>&nbsp;<a href="index-4.html">R</a>&nbsp;<a name="I:E">
 <!--   -->
 </a>
-<h2 class="title">I</h2>
+<h2 class="title">E</h2>
 <dl>
-<dt><a href="../io/github/techgnious/package-summary.html">io.github.techgnious</a> - package io.github.techgnious</dt>
-<dd>&nbsp;</dd>
-<dt><a href="../io/github/techgnious/IVCompressor.html" title="class in io.github.techgnious"><span class="typeNameLink">IVCompressor</span></a> - Class in <a href="../io/github/techgnious/package-summary.html">io.github.techgnious</a></dt>
+<dt><span class="memberNameLink"><a href="../io/github/techgnious/IVCompressor.html#encodeVideoWithAttributes-byte:A-io.github.techgnious.dto.VideoFormats-io.github.techgnious.dto.IVAudioAttributes-io.github.techgnious.dto.IVVideoAttributes-">encodeVideoWithAttributes(byte[], VideoFormats, IVAudioAttributes, IVVideoAttributes)</a></span> - Method in class io.github.techgnious.<a href="../io/github/techgnious/IVCompressor.html" title="class in io.github.techgnious">IVCompressor</a></dt>
 <dd>
-<div class="block">Base Class to handle compression or conversion of Image/Video Files
+<div class="block">This method helps in converting the video content to reduced size with lower
+ resolution with user defined attributes
 
- Operations supported:
+ Encodes the video with custom attributes thereby reducing the size of the
+ video with better quality
 
- Resize Image Convert Image Resize Video Resize and Convert Video</div>
-</dd>
-<dt><span class="memberNameLink"><a href="../io/github/techgnious/IVCompressor.html#IVCompressor--">IVCompressor()</a></span> - Constructor for class io.github.techgnious.<a href="../io/github/techgnious/IVCompressor.html" title="class in io.github.techgnious">IVCompressor</a></dt>
-<dd>
-<div class="block">Instance invokes with default encode settings and attributes</div>
+ Maintains the best compressed quality</div>
 </dd>
 </dl>
-<a href="index-1.html">E</a>&nbsp;<a href="index-2.html">I</a>&nbsp;<a href="index-3.html">R</a>&nbsp;</div>
+<a href="index-1.html">C</a>&nbsp;<a href="index-2.html">E</a>&nbsp;<a href="index-3.html">I</a>&nbsp;<a href="index-4.html">R</a>&nbsp;</div>
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->