WPS: Added comments for main data structures

diff --git a/src/wps/wps.h b/src/wps/wps.h
index 3965acb..0d08e1a 100644 (file)
--- a/src/wps/wps.h
+++ b/src/wps/wps.h
@@ -1,6 +1,6 @@
 /*
  * Wi-Fi Protected Setup
- * Copyright (c) 2007, Jouni Malinen <j@w1.fi>
+ * Copyright (c) 2007-2008, Jouni Malinen <j@w1.fi>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 2 as
@@ -91,6 +91,12 @@ struct wps_registrar_config {
 };
 
 
+/**
+ * struct wps_context - Long term WPS context data
+ *
+ * This data is stored at the higher layer Authenticator or Supplicant data
+ * structures and it is maintained over multiple registration protocol runs.
+ */
 struct wps_context {
        int ap;
        struct wps_registrar *registrar;

diff --git a/src/wps/wps_i.h b/src/wps/wps_i.h
index 806ba9f..8d6242b 100644 (file)
--- a/src/wps/wps_i.h
+++ b/src/wps/wps_i.h
@@ -18,6 +18,12 @@
 #include "wps.h"
 #include "wps_defs.h"
 
+/**
+ * struct wps_data - WPS registration protocol data
+ *
+ * This data is stored at the EAP-WSC server/peer method and it is kept for a
+ * single registration protocol run.
+ */
 struct wps_data {
        int authenticator;
        struct wps_context *wps;