diff options
author | norly <ny-git@enpas.org> | 2013-06-28 02:35:44 +0100 |
---|---|---|
committer | norly <ny-git@enpas.org> | 2013-06-28 02:35:44 +0100 |
commit | 50b85e44529f195bf8156e9c0045d8b017ee26f5 (patch) | |
tree | f0ecaecdacafdb44206381d11c9d159d2e4e4d6b /include/libelfu/elfops.h | |
parent | 28507233568a6deb80e243bd82df1e93f0b136a0 (diff) |
Annotate doxygen-styledoxygen
Diffstat (limited to 'include/libelfu/elfops.h')
-rw-r--r-- | include/libelfu/elfops.h | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/include/libelfu/elfops.h b/include/libelfu/elfops.h index 4131f41..dde51bc 100644 --- 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); |