From 8f421d3ba7a467ceb3d8e735c9910d39c5a8c2a4 Mon Sep 17 00:00:00 2001 From: caraplana1 Date: Wed, 29 May 2024 19:32:53 -0400 Subject: [PATCH] Documentation revision --- ComicConverter/Comic.cs | 2 +- Docs/ClassDocs.md | 50 ++++++++++++++--------------------------- 2 files changed, 18 insertions(+), 34 deletions(-) diff --git a/ComicConverter/Comic.cs b/ComicConverter/Comic.cs index 5fdb287..111f8b7 100644 --- a/ComicConverter/Comic.cs +++ b/ComicConverter/Comic.cs @@ -20,7 +20,7 @@ public class Comic public string Path { get; } /// - /// The given comic's format enum. + /// Comic's format enum. /// /// Enum public ComicFormat Format { get; } diff --git a/Docs/ClassDocs.md b/Docs/ClassDocs.md index 3aabfb5..54ad7b8 100644 --- a/Docs/ClassDocs.md +++ b/Docs/ClassDocs.md @@ -13,72 +13,56 @@ List of class. ### Attributes -* `Path` - `Public String`
+* `Path`
Comic File direction. -* `Format` - `Public ComicFormat`
+* `Format`
Comic's format enum. ### Constructors * `Comic(string comicPath)` -* `Comic(string comicPath, ComicFormat format)` ### Methods -* `Convert(string outputPath, ComicFormat format)` - `Public void`
- Method to convert the comic to any supported format into any direction. - -* `FindComicFormat()` - `Private ComicFormat`
- 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`
- Verify is the output format to convert is suported. - -* `FindExtractorImageAction(ComicFormat format)` - `Private Action`
- Find the correct method to extract images from the supported file given an format. - -* `FindComicBuilderAction(ComicFormat format)` - `Private Action`
- 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`
+* `CreateCBZ(string[] imagesPaths, string fileName)`
Creates zip file but with cbz extension -* `CreateCBT(string[] imagesPaths, string fileName)` - `Public void`
+* `CreateCBT(string[] imagesPaths, string fileName)`
Creates Tar file but with cbt extension -* `CreatePdf(string[] imagesPaths, string fileName)` - `Public void`
+* `CreatePdf(string[] imagesPaths, string fileName)`
Creates Pdf Files with a image per page. -* `CreateHiddenDir(string[] filesPaths, string dirName)` - `Private DirectoryInfo`
- Simple funtion to create a hidden directory and copy all files specificataed. - ## ImageExporter (class) ### Methods -* `UnRar(string filePath, string outputDir = ".")` - `Public void`
+* `UnRar(string filePath, string outputDir = ".")`
Extract rar or cbr file in given directory. -* `UnZip(string filePath, string outputDir = ".")` - `Public void`
+* `UnZip(string filePath, string outputDir = ".")`
Extract zip or cbz file in given directory. -* `UnTar(string filePath, string outputDir = ".")` - `Public void`
+* `UnTar(string filePath, string outputDir = ".")`
Extract tar or cbt file in given directory. -* `UnSevenZip(string filePath, string outputDir = ".")` - `Public void`
-Extract 7z or cb7 file in given directory. - -* `ExtractPdfImages(string filePath, string outputDir = ".")` - `Public void`
+* `ExtractPdfImages(string filePath, string outputDir = ".")`
Extract Jpeg from pdf file to a directory. -* `ExtractJpegFromPdf(PdfDictionary image, string name)` - `Private void`
-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`