Annotate doxygen-style

[centaur.git] / include / elfhandle.h

diff --git a/include/elfhandle.h b/include/elfhandle.h
index c15dd501ab528cd9c094f7e8186722dba061b95e..e9481808c36ee694b0489ab62a8ef497ae038ece 100644 (file)
--- a/include/elfhandle.h
+++ b/include/elfhandle.h
@@ -1,11 +1,15 @@
 #ifndef __ELFHANDLE_H__
 #define __ELFHANDLE_H__
 
-#include <libelf/libelf.h>
+#include <libelf.h>
 
+/*!
+ * A simple pair of a file descriptor and a libelf handle,
+ * used to simplify elfucli.
+ */
 typedef struct {
-  int fd;
-  Elf *e;
+  int fd;   /*!< File handle */
+  Elf *e;   /*!< libelf handle */
 } ELFHandles;