Documentation revision

ComicConverter/Comic.cs

@@ -20,7 +20,7 @@ public class Comic
         public string Path { get; }
 
         /// <summary>
-        /// The given comic's format enum.
+        /// Comic's format enum.
         /// </summary>
         /// <value>Enum</value>
         public ComicFormat Format { get; }

Docs/ClassDocs.md

@@ -13,72 +13,56 @@ List of class.
 
 ### Attributes
 
-* `Path` - `Public String` <br/>
+* `Path` <br/>
   Comic File direction.
 
-* `Format` - `Public ComicFormat` <br/>
+* `Format` <br/>
   Comic's format enum.
 
 ### Constructors
 
 * `Comic(string comicPath)`
-* `Comic(string comicPath, ComicFormat format)`
 
 ### Methods
 
-* `Convert(string outputPath, ComicFormat format)` - `Public void` <br/>
-  Method to convert the comic to any supported format into any direction.
-
-* `FindComicFormat()` - `Private ComicFormat` <br/>
-  Method to find the comic format. If the comic is not a file that is supported will throw an exception.
-
-* `IsValidOutputFormat(ComicFormat format)` - `Private bool` <br/>
-  Verify is the output format to convert is suported.
-
-* `FindExtractorImageAction(ComicFormat format)` - `Private Action<string, string>` <br/>
-  Find the correct method to extract images from the supported file given an format.
-
-* `FindComicBuilderAction(ComicFormat format)` - `Private Action<string[], string>` <br/>
-  Find the correct Method to created a comic in the given supproted format.
+* `Convert(string outputPath, ComicFormat format)`
+  Method to convert the comic to any supported format.
 
 ## ComicBuilder (class)
 
 ### Methods
 
-* `CreateCBZ(string[] imagesPaths, string fileName)` - `Public void` <br/>
+* `CreateCBZ(string[] imagesPaths, string fileName)` <br/>
   Creates zip file but with cbz extension
 
-* `CreateCBT(string[] imagesPaths, string fileName)` - `Public void` <br/>
+* `CreateCBT(string[] imagesPaths, string fileName)` <br/>
   Creates Tar file but with cbt extension
 
-* `CreatePdf(string[] imagesPaths, string fileName)` - `Public void` <br/>
+* `CreatePdf(string[] imagesPaths, string fileName)` <br/>
   Creates Pdf Files with a image per page.
 
-* `CreateHiddenDir(string[] filesPaths, string dirName)` - `Private DirectoryInfo` <br>
-  Simple funtion to create a hidden directory and copy all files specificataed.
-
 ## ImageExporter (class)
 
 ### Methods
 
-* `UnRar(string filePath, string outputDir = ".")` - `Public void` <br/>
+* `UnRar(string filePath, string outputDir = ".")` <br/>
 Extract rar or cbr file in given directory.
 
-* `UnZip(string filePath, string outputDir = ".")` - `Public void` <br/>
+* `UnZip(string filePath, string outputDir = ".")` <br/>
 Extract zip or cbz file in given directory.
 
-* `UnTar(string filePath, string outputDir = ".")` - `Public void` <br/>
+* `UnTar(string filePath, string outputDir = ".")` <br/>
 Extract tar or cbt file in given directory.
 
-* `UnSevenZip(string filePath, string outputDir = ".")` - `Public void` <br/>
-Extract 7z or cb7 file in given directory.
-
-* `ExtractPdfImages(string filePath, string outputDir = ".")` - `Public void` <br>
+* `ExtractPdfImages(string filePath, string outputDir = ".")` <br>
 Extract Jpeg from pdf file to a directory.
 
-* `ExtractJpegFromPdf(PdfDictionary image, string name)` - `Private void` <br>
-Write to a file the jpeg bytes.
 
 ## ComicFormat (enum)
 
-Enum to identify formats of comics.
+Enum for all comic format available.
+
+`CBR`\
+`CBZ`\
+`CBT`\
+`PDF`