docs: added docstrings

2024-08-26 22:59:37 -04:00
parent e8bd6e4179
commit b3e99092fc
5 changed files with 55 additions and 104 deletions
--- a/comic/archive.go
+++ b/comic/archive.go
@@ -18,6 +18,10 @@ func (a ArchiveError) Error() string {
 	return a.Message
 }

+// Archive creates a zip archive of the comic files.
+//
+// It takes no parameters.
+// Returns an error if the operation fails.
 func (c *Comic) Archive() error {

 	outputPath := filepath.Join(c.LibraryPath, c.Title, c.Title+".cbz")