From 98d5b90032a970b8bb7961fc01ec40e639038f09 Mon Sep 17 00:00:00 2001 From: Daniel Scharrer Date: Sun, 3 Aug 2014 14:51:36 +0200 Subject: [PATCH] Add comments describing each source file's purpose Implements task #27. --- src/cli/debug.hpp | 5 +++++ src/crypto/adler32.hpp | 7 ++++++- src/crypto/checksum.hpp | 5 +++++ src/crypto/crc32.hpp | 5 +++++ src/crypto/hasher.hpp | 5 +++++ src/crypto/iteratedhash.hpp | 5 +++++ src/crypto/md5.hpp | 5 +++++ src/crypto/sha1.hpp | 5 +++++ src/loader/exereader.hpp | 5 +++++ src/loader/offsets.hpp | 5 +++++ src/release.hpp | 5 +++++ src/setup/component.hpp | 5 +++++ src/setup/data.hpp | 5 +++++ src/setup/delete.hpp | 5 +++++ src/setup/directory.hpp | 5 +++++ src/setup/expression.hpp | 5 +++++ src/setup/file.hpp | 5 +++++ src/setup/header.hpp | 5 +++++ src/setup/icon.hpp | 5 +++++ src/setup/ini.hpp | 5 +++++ src/setup/item.hpp | 5 +++++ src/setup/language.hpp | 5 +++++ src/setup/message.hpp | 5 +++++ src/setup/permission.hpp | 5 +++++ src/setup/registry.hpp | 5 +++++ src/setup/run.hpp | 5 +++++ src/setup/task.hpp | 5 +++++ src/setup/type.hpp | 5 +++++ src/setup/version.hpp | 5 +++++ src/setup/windows.hpp | 5 +++++ src/util/enum.hpp | 5 +++++ src/util/storedenum.hpp | 5 +++++ 32 files changed, 161 insertions(+), 1 deletion(-) diff --git a/src/cli/debug.hpp b/src/cli/debug.hpp index 2fe1002..545f741 100644 --- a/src/cli/debug.hpp +++ b/src/cli/debug.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Debug output functions. + */ #ifndef INNOEXTRACT_CLI_DEBUG_HPP #define INNOEXTRACT_CLI_DEBUG_HPP diff --git a/src/crypto/adler32.hpp b/src/crypto/adler32.hpp index fd72e6a..665fb42 100644 --- a/src/crypto/adler32.hpp +++ b/src/crypto/adler32.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Adler-32 checksum routines. + */ #ifndef INNOEXTRACT_CRYPTO_ADLER32_HPP #define INNOEXTRACT_CRYPTO_ADLER32_HPP @@ -29,7 +34,7 @@ namespace crypto { -//! ADLER-32 checksum calculations +//! Adler-32 checksum calculations struct adler32 : public checksum_base { void init() { s1 = 1, s2 = 0; } diff --git a/src/crypto/checksum.hpp b/src/crypto/checksum.hpp index bf56627..0c18fc0 100644 --- a/src/crypto/checksum.hpp +++ b/src/crypto/checksum.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Checksum structures and utilities. + */ #ifndef INNOEXTRACT_CRYPTO_CHECKSUM_HPP #define INNOEXTRACT_CRYPTO_CHECKSUM_HPP diff --git a/src/crypto/crc32.hpp b/src/crypto/crc32.hpp index 408f12b..b5f64e4 100644 --- a/src/crypto/crc32.hpp +++ b/src/crypto/crc32.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * CRC32 checksum routines. + */ #ifndef INNOEXTRACT_CRYPTO_CRC32_HPP #define INNOEXTRACT_CRYPTO_CRC32_HPP diff --git a/src/crypto/hasher.hpp b/src/crypto/hasher.hpp index dd97de4..34a0fb0 100644 --- a/src/crypto/hasher.hpp +++ b/src/crypto/hasher.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Utility to hash data with a configurable hash function. + */ #ifndef INNOEXTRACT_CRYPTO_HASHER_HPP #define INNOEXTRACT_CRYPTO_HASHER_HPP diff --git a/src/crypto/iteratedhash.hpp b/src/crypto/iteratedhash.hpp index a638df4..3aabfcb 100644 --- a/src/crypto/iteratedhash.hpp +++ b/src/crypto/iteratedhash.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Generic hashing utilities. + */ #ifndef INNOEXTRACT_CRYPTO_ITERATEDHASH_HPP #define INNOEXTRACT_CRYPTO_ITERATEDHASH_HPP diff --git a/src/crypto/md5.hpp b/src/crypto/md5.hpp index 258cc31..47e8199 100644 --- a/src/crypto/md5.hpp +++ b/src/crypto/md5.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * MD5 hashing routines. + */ #ifndef INNOEXTRACT_CRYPTO_MD5_HPP #define INNOEXTRACT_CRYPTO_MD5_HPP diff --git a/src/crypto/sha1.hpp b/src/crypto/sha1.hpp index 22a6d47..c6f31ec 100644 --- a/src/crypto/sha1.hpp +++ b/src/crypto/sha1.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * SHA-1 hashing routines. + */ #ifndef INNOEXTRACT_CRYPTO_SHA1_HPP #define INNOEXTRACT_CRYPTO_SHA1_HPP diff --git a/src/loader/exereader.hpp b/src/loader/exereader.hpp index 1abb699..6fe0ab5 100644 --- a/src/loader/exereader.hpp +++ b/src/loader/exereader.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Functions to find resources in Windows executables. + */ #ifndef INNOEXTRACT_LOADER_EXEREADER_HPP #define INNOEXTRACT_LOADER_EXEREADER_HPP diff --git a/src/loader/offsets.hpp b/src/loader/offsets.hpp index 4761550..bb22060 100644 --- a/src/loader/offsets.hpp +++ b/src/loader/offsets.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Functions to find Inno Setup data inside an executable. + */ #ifndef INNOEXTRACT_LOADER_OFFSETS_HPP #define INNOEXTRACT_LOADER_OFFSETS_HPP diff --git a/src/release.hpp b/src/release.hpp index 9fcf900..6e09b34 100644 --- a/src/release.hpp +++ b/src/release.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Strings describing the innoextract version. + */ #ifndef INNOEXTRACT_RELEASE_HPP #define INNOEXTRACT_RELEASE_HPP diff --git a/src/setup/component.hpp b/src/setup/component.hpp index 927ed00..866cda0 100644 --- a/src/setup/component.hpp +++ b/src/setup/component.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for setup components stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_COMPONENT_HPP #define INNOEXTRACT_SETUP_COMPONENT_HPP diff --git a/src/setup/data.hpp b/src/setup/data.hpp index ac6be36..a9d8517 100644 --- a/src/setup/data.hpp +++ b/src/setup/data.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for file content entries stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_DATA_HPP #define INNOEXTRACT_SETUP_DATA_HPP diff --git a/src/setup/delete.hpp b/src/setup/delete.hpp index bbe4a03..77385d9 100644 --- a/src/setup/delete.hpp +++ b/src/setup/delete.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for deletion entries stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_DELETE_HPP #define INNOEXTRACT_SETUP_DELETE_HPP diff --git a/src/setup/directory.hpp b/src/setup/directory.hpp index 27ace91..e92f4ef 100644 --- a/src/setup/directory.hpp +++ b/src/setup/directory.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for directory entries stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_DIRECTORY_HPP #define INNOEXTRACT_SETUP_DIRECTORY_HPP diff --git a/src/setup/expression.hpp b/src/setup/expression.hpp index b0c4c4e..c34558c 100644 --- a/src/setup/expression.hpp +++ b/src/setup/expression.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Functions to evaluation Inno Setup boolean expressions. + */ #ifndef INNOEXTRACT_SETUP_EXPRESSION_HPP #define INNOEXTRACT_SETUP_EXPRESSION_HPP diff --git a/src/setup/file.hpp b/src/setup/file.hpp index 6f3eea1..b8e4198 100644 --- a/src/setup/file.hpp +++ b/src/setup/file.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for file entries stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_FILE_HPP #define INNOEXTRACT_SETUP_FILE_HPP diff --git a/src/setup/header.hpp b/src/setup/header.hpp index e3e3aad..03b633e 100644 --- a/src/setup/header.hpp +++ b/src/setup/header.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for the main setup header in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_HEADER_HPP #define INNOEXTRACT_SETUP_HEADER_HPP diff --git a/src/setup/icon.hpp b/src/setup/icon.hpp index 94d5ae4..1dadb55 100644 --- a/src/setup/icon.hpp +++ b/src/setup/icon.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for menu/desktop shortcuts stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_ICON_HPP #define INNOEXTRACT_SETUP_ICON_HPP diff --git a/src/setup/ini.hpp b/src/setup/ini.hpp index ab0346c..cb8feeb 100644 --- a/src/setup/ini.hpp +++ b/src/setup/ini.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for .ini entries stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_INI_HPP #define INNOEXTRACT_SETUP_INI_HPP diff --git a/src/setup/item.hpp b/src/setup/item.hpp index 08a89e3..fe11904 100644 --- a/src/setup/item.hpp +++ b/src/setup/item.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for setup items stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_ITEM_HPP #define INNOEXTRACT_SETUP_ITEM_HPP diff --git a/src/setup/language.hpp b/src/setup/language.hpp index 929c930..98b055d 100644 --- a/src/setup/language.hpp +++ b/src/setup/language.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for language entries stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_LANGUAGE_HPP #define INNOEXTRACT_SETUP_LANGUAGE_HPP diff --git a/src/setup/message.hpp b/src/setup/message.hpp index 4bb77d3..9514b0f 100644 --- a/src/setup/message.hpp +++ b/src/setup/message.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for custom localized messages stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_MESSAGE_HPP #define INNOEXTRACT_SETUP_MESSAGE_HPP diff --git a/src/setup/permission.hpp b/src/setup/permission.hpp index b8146d7..579392b 100644 --- a/src/setup/permission.hpp +++ b/src/setup/permission.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for permission entries stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_PERMISSION_HPP #define INNOEXTRACT_SETUP_PERMISSION_HPP diff --git a/src/setup/registry.hpp b/src/setup/registry.hpp index 0e81877..94c1c9e 100644 --- a/src/setup/registry.hpp +++ b/src/setup/registry.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for Windows registry entries stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_REGISTRY_HPP #define INNOEXTRACT_SETUP_REGISTRY_HPP diff --git a/src/setup/run.hpp b/src/setup/run.hpp index 1f985f0..850f73a 100644 --- a/src/setup/run.hpp +++ b/src/setup/run.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for custom command entries stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_RUN_HPP #define INNOEXTRACT_SETUP_RUN_HPP diff --git a/src/setup/task.hpp b/src/setup/task.hpp index cc3a369..958e8fe 100644 --- a/src/setup/task.hpp +++ b/src/setup/task.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for setup tasks stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_TASK_HPP #define INNOEXTRACT_SETUP_TASK_HPP diff --git a/src/setup/type.hpp b/src/setup/type.hpp index 72e6801..077ebcc 100644 --- a/src/setup/type.hpp +++ b/src/setup/type.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for setup types stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_TYPE_HPP #define INNOEXTRACT_SETUP_TYPE_HPP diff --git a/src/setup/version.hpp b/src/setup/version.hpp index 0c976a5..66e94ad 100644 --- a/src/setup/version.hpp +++ b/src/setup/version.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Inno Setup version number utilities. + */ #ifndef INNOEXTRACT_SETUP_VERSION_HPP #define INNOEXTRACT_SETUP_VERSION_HPP diff --git a/src/setup/windows.hpp b/src/setup/windows.hpp index 2a3d726..591084d 100644 --- a/src/setup/windows.hpp +++ b/src/setup/windows.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Structures for Windows version numbers stored in Inno Setup files. + */ #ifndef INNOEXTRACT_SETUP_WINDOWS_HPP #define INNOEXTRACT_SETUP_WINDOWS_HPP diff --git a/src/util/enum.hpp b/src/util/enum.hpp index 0c10c53..9d98835 100644 --- a/src/util/enum.hpp +++ b/src/util/enum.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Utilities to associate strings with enum values. + */ #ifndef INNOEXTRACT_UTIL_ENUM_HPP #define INNOEXTRACT_UTIL_ENUM_HPP diff --git a/src/util/storedenum.hpp b/src/util/storedenum.hpp index b09a047..52b4b08 100644 --- a/src/util/storedenum.hpp +++ b/src/util/storedenum.hpp @@ -18,6 +18,11 @@ * 3. This notice may not be removed or altered from any source distribution. */ +/*! + * \file + * + * Utilities for decoding stored enum values into run-time values. + */ #ifndef INNOEXTRACT_UTIL_STOREDENUM_HPP #define INNOEXTRACT_UTIL_STOREDENUM_HPP