diff options
| author | Matthias Schiffer <mschiffer@universe-factory.net> | 2015-03-22 17:51:09 +0100 |
|---|---|---|
| committer | Matthias Schiffer <mschiffer@universe-factory.net> | 2015-03-22 17:51:09 +0100 |
| commit | 335a4998e322ed4fe05558b75dae3244ca6d7c0d (patch) | |
| tree | 7f51938e2f9f66d7d97a577e5ef612a700a42203 | |
| parent | 17a0a04f09161f3e79eb3143bb0d36a89061b255 (diff) | |
| download | fastd-335a4998e322ed4fe05558b75dae3244ca6d7c0d.tar fastd-335a4998e322ed4fe05558b75dae3244ca6d7c0d.zip | |
Add missing Doxygen comments
| -rw-r--r-- | src/shell.c | 1 | ||||
| -rw-r--r-- | src/types.h | 10 |
2 files changed, 6 insertions, 5 deletions
diff --git a/src/shell.c b/src/shell.c index 3a617be..b678ba5 100644 --- a/src/shell.c +++ b/src/shell.c @@ -75,6 +75,7 @@ void fastd_shell_env_free(fastd_shell_env_t *env) { free(env); } +/** Adds an interface name to a shell environment */ void fastd_shell_env_set_iface(fastd_shell_env_t *env, const fastd_iface_t *iface) { if (iface) fastd_shell_env_set(env, "INTERFACE", iface->name); diff --git a/src/types.h b/src/types.h index dbb4d3c..5a4bd06 100644 --- a/src/types.h +++ b/src/types.h @@ -77,11 +77,11 @@ typedef enum fastd_drop_caps { /** Types of file descriptors to poll on */ typedef enum fastd_poll_type { - POLL_TYPE_UNSPEC = 0, - POLL_TYPE_ASYNC, - POLL_TYPE_STATUS, - POLL_TYPE_IFACE, - POLL_TYPE_SOCKET, + POLL_TYPE_UNSPEC = 0, /**< Unspecified file descriptor type */ + POLL_TYPE_ASYNC, /**< The async action socket */ + POLL_TYPE_STATUS, /**< The status socket */ + POLL_TYPE_IFACE, /**< A TUN/TAP interface */ + POLL_TYPE_SOCKET, /**< A network socket */ } fastd_poll_type_t; |