aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJouni Malinen <j@w1.fi>2005-06-18 18:56:20 (GMT)
committerJouni Malinen <j@w1.fi>2005-06-18 18:56:20 (GMT)
commit220cb073a0ff0652ea104c0c9b5fafea56431523 (patch)
tree4a44d9c1880f0ca830faf0f4a28a6358841a8cef
parentba0606582884f0be284eb389269264043328f9a7 (diff)
downloadhostap-history-220cb073a0ff0652ea104c0c9b5fafea56431523.zip
hostap-history-220cb073a0ff0652ea104c0c9b5fafea56431523.tar.gz
hostap-history-220cb073a0ff0652ea104c0c9b5fafea56431523.tar.bz2
Added key data structures in Doxygen docs when EXTRACT_ALL=no.
-rw-r--r--wpa_supplicant/config.h3
-rw-r--r--wpa_supplicant/config_ssid.h37
-rw-r--r--wpa_supplicant/ctrl_iface.c7
-rw-r--r--wpa_supplicant/eapol_sm.c3
-rw-r--r--wpa_supplicant/l2_packet.c8
-rw-r--r--wpa_supplicant/wpa_supplicant_i.h8
6 files changed, 63 insertions, 3 deletions
diff --git a/wpa_supplicant/config.h b/wpa_supplicant/config.h
index 72ff2ae..00560c2 100644
--- a/wpa_supplicant/config.h
+++ b/wpa_supplicant/config.h
@@ -23,6 +23,9 @@
#include "config_ssid.h"
+/**
+ * struct wpa_config - wpa_supplicant configuration data
+ */
struct wpa_config {
struct wpa_ssid *ssid; /* global network list */
struct wpa_ssid **pssid; /* per priority network lists (in priority
diff --git a/wpa_supplicant/config_ssid.h b/wpa_supplicant/config_ssid.h
index 23826a6..4a89dba 100644
--- a/wpa_supplicant/config_ssid.h
+++ b/wpa_supplicant/config_ssid.h
@@ -38,10 +38,41 @@
#define PMK_LEN 32
#define EAP_PSK_LEN 16
+/**
+ * struct wpa_ssid - Network configuration data
+ *
+ * This structure includes all the configuration variables for a network. The
+ * data is read from configuration file and each network block is mapped to a
+ * struct wpa_ssid instance.
+ */
struct wpa_ssid {
- struct wpa_ssid *next; /* next network in global list */
- struct wpa_ssid *pnext; /* next network in per-priority list */
- int id; /* unique id for ctrl_iface */
+ /**
+ * next - Next network in global list
+ *
+ * This pointer can be used to iterate over all networks. The head of
+ * this list is stored in the ssid field of struct wpa_config.
+ */
+ struct wpa_ssid *next;
+
+ /**
+ * pnext - Next network in per-priority list
+ *
+ * This pointer can be used to iterate over all networks in the same
+ * priority class. The heads of these list are stored in the pssid
+ * fields of struct wpa_config.
+ */
+ struct wpa_ssid *pnext;
+
+ /**
+ * id - Unique id for the network
+ *
+ * This identifier is used as a unique identifier for each network
+ * block when using the control interface. Each network is allocated an
+ * id when it is being created, either when reading the configuration
+ * file or when a new network is added through the control interface.
+ */
+ int id;
+
int priority;
u8 *ssid;
size_t ssid_len;
diff --git a/wpa_supplicant/ctrl_iface.c b/wpa_supplicant/ctrl_iface.c
index cc52e80..26a1fc4 100644
--- a/wpa_supplicant/ctrl_iface.c
+++ b/wpa_supplicant/ctrl_iface.c
@@ -49,6 +49,13 @@ typedef int socklen_t;
#endif /* CONFIG_CTRL_IFACE_UDP */
+/**
+ * struct wpa_ctrl_dst - Internal data structure of control interface monitors
+ *
+ * This structure is used to store information about registered control
+ * interface monitors into struct wpa_supplicant. This data is private to
+ * ctrl_iface.c and should not be touched directly from other files.
+ */
struct wpa_ctrl_dst {
struct wpa_ctrl_dst *next;
CTRL_IFACE_SOCK addr;
diff --git a/wpa_supplicant/eapol_sm.c b/wpa_supplicant/eapol_sm.c
index 89e62d1..969d554 100644
--- a/wpa_supplicant/eapol_sm.c
+++ b/wpa_supplicant/eapol_sm.c
@@ -29,6 +29,9 @@
/* IEEE 802.1X-2004 - Supplicant - EAPOL state machines */
+/**
+ * struct eapol_sm - Internal data for EAPOL state machines
+ */
struct eapol_sm {
/* Timers */
unsigned int authWhile;
diff --git a/wpa_supplicant/l2_packet.c b/wpa_supplicant/l2_packet.c
index e55b210..2619fff 100644
--- a/wpa_supplicant/l2_packet.c
+++ b/wpa_supplicant/l2_packet.c
@@ -41,6 +41,14 @@
#include "l2_packet.h"
+/**
+ * struct l2_packet_data - Internal l2_packet data structure
+ *
+ * This structure is used by the l2_packet implementation to store its private
+ * data. Other files use a pointer to this data when calling the l2_packet
+ * functions, but the contents of this structure should not be used directly
+ * outside l2_packet implementation.
+ */
struct l2_packet_data {
#ifdef USE_DNET_PCAP
pcap_t *pcap;
diff --git a/wpa_supplicant/wpa_supplicant_i.h b/wpa_supplicant/wpa_supplicant_i.h
index 2dd4341..8335e63 100644
--- a/wpa_supplicant/wpa_supplicant_i.h
+++ b/wpa_supplicant/wpa_supplicant_i.h
@@ -34,6 +34,14 @@ typedef enum {
struct wpa_scan_result;
struct wpa_sm;
+/**
+ * struct wpa_supplicant - Internal data for wpa_supplicant
+ *
+ * This structure contains the internal data for core wpa_supplicant code. This
+ * should be only used directly from the core code. However, a pointer to this
+ * data is used from other files as an arbitrary context pointer in calls to
+ * core functions.
+ */
struct wpa_supplicant {
struct wpa_supplicant *head;
struct wpa_supplicant *next;