From 496d59e1073d9d6422fe2715a273377e68b873d5 Mon Sep 17 00:00:00 2001 From: Zardshard <0azrune6@zard.anonaddy.com> Date: Tue, 16 May 2023 14:34:14 -0400 Subject: [PATCH] Icon-O-Matic: Document the document saver classes Change-Id: I1985108bbc4e1030b2dc0e94cfb1c0706b1806a4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/6442 Tested-by: Commit checker robot Reviewed-by: Adrien Destugues --- src/apps/icon-o-matic/document/savers/AttributeSaver.h | 1 + src/apps/icon-o-matic/document/savers/BitmapSetSaver.h | 1 + src/apps/icon-o-matic/document/savers/DocumentSaver.h | 1 + src/apps/icon-o-matic/document/savers/FileSaver.h | 1 + src/apps/icon-o-matic/document/savers/MessengerSaver.h | 1 + src/apps/icon-o-matic/document/savers/NativeSaver.h | 2 +- src/apps/icon-o-matic/document/savers/SimpleFileSaver.h | 2 +- 7 files changed, 7 insertions(+), 2 deletions(-) diff --git a/src/apps/icon-o-matic/document/savers/AttributeSaver.h b/src/apps/icon-o-matic/document/savers/AttributeSaver.h index 98a3bb2b2e..27cdfe6ee0 100644 --- a/src/apps/icon-o-matic/document/savers/AttributeSaver.h +++ b/src/apps/icon-o-matic/document/savers/AttributeSaver.h @@ -14,6 +14,7 @@ #include "DocumentSaver.h" +/*! Saves the HVIF to a file's attribute */ class AttributeSaver : public DocumentSaver { public: AttributeSaver(const entry_ref& ref, diff --git a/src/apps/icon-o-matic/document/savers/BitmapSetSaver.h b/src/apps/icon-o-matic/document/savers/BitmapSetSaver.h index 97145e685c..49f834c72b 100644 --- a/src/apps/icon-o-matic/document/savers/BitmapSetSaver.h +++ b/src/apps/icon-o-matic/document/savers/BitmapSetSaver.h @@ -11,6 +11,7 @@ #include "FileSaver.h" +/*! Saves a set of png images of various sizes */ class BitmapSetSaver : public FileSaver { public: BitmapSetSaver(const entry_ref& ref); diff --git a/src/apps/icon-o-matic/document/savers/DocumentSaver.h b/src/apps/icon-o-matic/document/savers/DocumentSaver.h index 53bb1850f0..fa67fdb73f 100644 --- a/src/apps/icon-o-matic/document/savers/DocumentSaver.h +++ b/src/apps/icon-o-matic/document/savers/DocumentSaver.h @@ -13,6 +13,7 @@ class Document; +/*! Interface for all the other savers to implement */ class DocumentSaver { public: DocumentSaver(); diff --git a/src/apps/icon-o-matic/document/savers/FileSaver.h b/src/apps/icon-o-matic/document/savers/FileSaver.h index 6e0ce45c01..641dcab5e5 100644 --- a/src/apps/icon-o-matic/document/savers/FileSaver.h +++ b/src/apps/icon-o-matic/document/savers/FileSaver.h @@ -13,6 +13,7 @@ #include "DocumentSaver.h" +/*! Interface for saving to a file */ class FileSaver : public DocumentSaver { public: FileSaver(const entry_ref& ref); diff --git a/src/apps/icon-o-matic/document/savers/MessengerSaver.h b/src/apps/icon-o-matic/document/savers/MessengerSaver.h index 28fc12e1a6..2f6a350f3a 100644 --- a/src/apps/icon-o-matic/document/savers/MessengerSaver.h +++ b/src/apps/icon-o-matic/document/savers/MessengerSaver.h @@ -13,6 +13,7 @@ #include "DocumentSaver.h" +/*! Sends a message with the HVIF file data over the given messenger */ class MessengerSaver : public DocumentSaver { public: MessengerSaver(const BMessenger& messenger); diff --git a/src/apps/icon-o-matic/document/savers/NativeSaver.h b/src/apps/icon-o-matic/document/savers/NativeSaver.h index 0a2e1eef4e..e87c343ba2 100644 --- a/src/apps/icon-o-matic/document/savers/NativeSaver.h +++ b/src/apps/icon-o-matic/document/savers/NativeSaver.h @@ -9,7 +9,7 @@ #include "AttributeSaver.h" #include "SimpleFileSaver.h" - +/*! Exports to the native Icon-O-Matic format */ class NativeSaver : public SimpleFileSaver { public: NativeSaver(const entry_ref& ref); diff --git a/src/apps/icon-o-matic/document/savers/SimpleFileSaver.h b/src/apps/icon-o-matic/document/savers/SimpleFileSaver.h index ba6f623bc8..10cbaa7eef 100644 --- a/src/apps/icon-o-matic/document/savers/SimpleFileSaver.h +++ b/src/apps/icon-o-matic/document/savers/SimpleFileSaver.h @@ -11,7 +11,7 @@ class Exporter; - +/*! Uses the specified Exporter to export the icon to a file */ class SimpleFileSaver : public FileSaver { public: SimpleFileSaver(Exporter* exporter,