Document the RestProxy classes

2 files changed, 15 insertions, 1 deletions

diff --git a/rest/rest-proxy-call.h b/rest/rest-proxy-call.h
index ac6a013..5373987 100644
--- a/rest/rest-proxy-call.h
+++ b/rest/rest-proxy-call.h
@@ -61,7 +61,8 @@ typedef struct {
  * @prepare: Virtual function called before making the request, This allows the
  * call to be modified, for example to add a signature.
  *
- * Class structure for #RestProxyCall.
+ * Class structure for #RestProxyCall for subclasses to implement specialised
+ * behaviour.
  */
 typedef struct {
   /*< private >*/
diff --git a/rest/rest-proxy.h b/rest/rest-proxy.h
index d95da66..d19ab7a 100644
--- a/rest/rest-proxy.h
+++ b/rest/rest-proxy.h
@@ -54,6 +54,19 @@ typedef struct {
   GObject parent;
 } RestProxy;
 
+/**
+ * RestProxyClass:
+ *
+ * @bind_valist: Virtual function called to bind parameters.
+ * @new_call: Virtual function called to construct a new #RestProxyCall.
+ * @simple_run_valist: Virtual function called when making a "simple" call.
+ *
+ * Class structure for #RestProxy for subclasses to implement specialised
+ * behaviour.
+ *
+ * Typically subclasses will override @new_call to construct a subclass of
+ * #RestProxyCall.
+ */
 typedef struct {
   GObjectClass parent_class;
   gboolean (*bind_valist)(RestProxy *proxy, va_list params);