Documentation fixes
[vlp.git] / src / edit / FindDialog.h
index b0c6d5e24a0df6c5f8b65f3c06cc6707ab59e104..9023808124d7635956e20b7d8f64271c8e0311e6 100644 (file)
@@ -7,13 +7,17 @@
 
 #include "ui/dialogs/FindDialog.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 namespace dialog {
 
 /**
  * Find Dialog class
- * Displays dialog for findinf text in source code
+ * Displays dialog for finding text in source code
  */
 class FindDialog : public QDialog, private Ui::FindDialog {
 public:
@@ -28,16 +32,16 @@ public:
        ~FindDialog();
 
        /**
-        * Gets user-passed program name
+        * Checks if search should be case sensitive
         * 
-        * @return program name entered in dialog
+        * @return true if search should be case sensitive, false otherwise
         */
        bool isCaseSensitive();
 
        /**
-        * Gets program code template
+        * Gets text to search for
         * 
-        * @return program code template with program name
+        * @return text to search for
         */
        QString getSearchText();
 };