Document MimeInfoEditor

Author: azubieta

src/libappimage/desktop_integration/integrator/MimeInfoEditor.h

@@ -11,9 +11,7 @@ namespace appimage {
     namespace desktop_integration {
         namespace integrator {
             /**
-             * @brief Modifies MimeInfo files to be deployed.
-             *
-             *
+             * @brief Edit MimeInfo files to be deployed
              */
             class MimeInfoEditor {
             public:
@@ -24,10 +22,22 @@ namespace appimage {
                  */
                 MimeInfoEditor(std::string data);
 
+                /**
+                 * Set the deploy id to be prepended to the icon file name
+                 * @param deployId
+                 */
                 void setDeployId(const std::string& deployId);
 
+                /**
+                 * Apply modification to the MimeInfo file
+                 * @return modified MimeInfo
+                 */
                 std::string edit();
 
+                /**
+                 * Extract the icon names from from the icon entry or the mime type name
+                 * @return names of the icons related to the mime types
+                 */
                 std::list<std::string> getMimeTypeIconNames() const;
 
             private: