summaryrefslogtreecommitdiffstats
path: root/src/include/eiotas_link.h
diff options
context:
space:
mode:
authorJérémy Zurcher <jeremy@asynk.ch>2012-05-29 16:13:14 +0200
committerJérémy Zurcher <jeremy@asynk.ch>2012-05-29 16:13:14 +0200
commit823df95bd73bf7195d9a9d3dacd418475c055bc8 (patch)
treea739b394f38bb023a853392c2a17a271d2e0ae33 /src/include/eiotas_link.h
parent82afdb93d790105246acfd5a47185ebd10961ab5 (diff)
downloadedoors-823df95bd73bf7195d9a9d3dacd418475c055bc8.zip
edoors-823df95bd73bf7195d9a9d3dacd418475c055bc8.tar.gz
documentation
Diffstat (limited to 'src/include/eiotas_link.h')
-rw-r--r--src/include/eiotas_link.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/include/eiotas_link.h b/src/include/eiotas_link.h
index 4692641..4cc4e44 100644
--- a/src/include/eiotas_link.h
+++ b/src/include/eiotas_link.h
@@ -19,11 +19,24 @@
#ifndef __EIOTAS_LINK_H__
#define __EIOTAS_LINK_H__
+/**
+ * @typedef Eiotas_Link
+ * Type for a Link between Eiotas_Iotas.
+ */
typedef struct _Eiotas_Link Eiotas_Link;
+/**
+ * @struct _Eiotas_Link
+ * Struct for a Link between Eiotas_Iotas.
+ */
struct _Eiotas_Link {
};
+/**
+ * @brief Free allocated resources.
+ *
+ * @param link The Eiotas_Link to free.
+ */
void eiotas_link_free(Eiotas_Link *link);
#endif // __EIOTAS_LINK_H__