[libcalamaresui] APIDOX for ErrorDialog

src/libcalamaresui/widgets/ErrorDialog.h

@@ -7,17 +7,16 @@
  *
  */
 
-#ifndef ERRORDIALOG_H
-#define ERRORDIALOG_H
+#ifndef LIBCALAMARESUI_ERRORDIALOG_H
+#define LIBCALAMARESUI_ERRORDIALOG_H
 
 #include <QDialog>
 
-
 namespace Ui
 {
 class ErrorDialog;
 }
-class QDialogButtonBox;
+
 namespace Calamares
 {
 class ErrorDialog : public QDialog
@@ -32,30 +31,46 @@ class ErrorDialog : public QDialog
 
 public:
     explicit ErrorDialog( QWidget* parent = nullptr );
-    ~ErrorDialog();
+    ~ErrorDialog() override;
 
+    /** @brief The heading (title) of the error dialog
+     *
+     * This is a short (one-line) title. It is human-readable, so should
+     * be translated at the time it is set.
+     */
     QString heading() const;
-
-    QString informativeText() const;
-
-    QString details() const;
-
     void setHeading( const QString& newHeading );
 
+    /** @brief The description of the problem
+     *
+     * Longer, human-readable, description of the problem. This text
+     * is word-wrapped as necessary.
+     */
+    QString informativeText() const;
     void setInformativeText( const QString& newInformativeText );
 
+    /** @brief Details of the problem
+     *
+     * This is generally command-output; it might not be translated
+     * when set. It should be considered "background to the informative
+     * text", or maybe "the reasons". Write the informative text for
+     * the end-user.
+     */
+    QString details() const;
     void setDetails( const QString& newDetails );
 
+    /** @brief Enable web-paste button
+     *
+     * The web-paste button can be configured at a global level,
+     * but each individual error dialog can be set separately.
+     */
     bool shouldOfferWebPaste() const;
     void setShouldOfferWebPaste( bool newShouldOfferWebPaste );
 
 signals:
     void headingChanged();
-
     void informativeTextChanged();
-
     void detailsChanged();
-
     void shouldOfferWebPasteChanged();
 
 private:
@@ -65,4 +80,4 @@ private:
 
 };  // namespace Calamares
 
-#endif  // ERRORDIALOG_H
+#endif  // LIBCALAMARESUI_ERRORDIALOG_H