gcr: More checks and docs for GcrPrompt

1 files changed, 8 insertions, 13 deletions

diff --git a/gcr/gcr-mock-prompter.c b/gcr/gcr-mock-prompter.c
index e506b3b..e72ef85 100644
--- a/gcr/gcr-mock-prompter.c
+++ b/gcr/gcr-mock-prompter.c
@@ -35,24 +35,19 @@
 /**
  * SECTION:gcr-mock-prompter
  * @title: GcrMockPrompter
- * @short_description: XXX
+ * @short_description: a mock GcrSystemPrompter for testing
  *
- * XXXX
- */
-
-/**
- * GcrMockPrompter:
+ * A mock GcrSystemPrompter used for testing against.
  *
- * XXX
- */
-
-/**
- * GcrMockPrompterClass:
+ * Use gcr_mock_prompter_start() to start the mock prompter in another
+ * thread. The returned string is the dbus address of the mock prompter.
+ * You can pass this to gcr_system_prompt_open() as the prompter bus name.
  *
- * The class for #GcrMockPrompter.
+ * Use the gcr_mock_prompter_expect_confirm_ok() function and friends before
+ * prompting to verify that the prompts are displayed as expected, and to
+ * provide a response.
  */
 
-
 GType   _gcr_mock_prompt_get_type       (void) G_GNUC_CONST;
 #define GCR_TYPE_MOCK_PROMPT            (_gcr_mock_prompt_get_type ())
 #define GCR_MOCK_PROMPT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GCR_TYPE_MOCK_PROMPT, GcrMockPrompt))