Annotate doxygen-style

[centaur.git] / include / libelfu / elfops.h

diff --git a/include/libelfu/elfops.h b/include/libelfu/elfops.h
index 4131f410967a96e82fb449b03171cbf81205ddc9..dde51bcd9993c7904cd11392164131393b059a63 100644 (file)
--- a/include/libelfu/elfops.h
+++ b/include/libelfu/elfops.h
@@ -1,3 +1,12 @@
+/*!
+ * @file elfops.h
+ * @brief Operations offered by libelfu on libelf handles
+ *
+ * This includes:
+ *  - Checks
+ *  - Post-processing for ELF specification compliance
+ */
+
 #ifndef __LIBELFU_ELFOPS_H_
 #define __LIBELFU_ELFOPS_H_
 
@@ -7,7 +16,22 @@
 #include <libelfu/types.h>
 
 
+/*!
+ * @brief Perform a large array of sanity checks.
+ * @param e libelf handle to file to be checked.
+ * @result 0 if successful.
+ *         Anything else indicates an error.
+ * @note If a file does not pass these checks,
+ *       then it cannot be processed by libelfu.
+ */
 int elfu_eCheck(Elf *e);
+
+
+
+/*!
+ * @brief Reorder PHDRs to comply with ELF specification.
+ * @param e libelf handle to file to be post-processed.
+ */
 void elfu_eReorderPhdrs(Elf *e);