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 <[email protected]> Reviewed-by: Adrien Destugues <[email protected]>
2023-05-18 10:45:21 +00:00
parent d38dcdde74
commit 496d59e107
7 changed files with 7 additions and 2 deletions
@@ -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,
@@ -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);
@@ -13,6 +13,7 @@

 class Document;

+/*! Interface for all the other savers to implement */
 class DocumentSaver {
 public:
 								DocumentSaver();
@@ -13,6 +13,7 @@

 #include "DocumentSaver.h"

+/*! Interface for saving to a file */
 class FileSaver : public DocumentSaver {
 public:
 								FileSaver(const entry_ref& ref);
@@ -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);
@@ -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);
@@ -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,