Add comments describing each source file's purpose

Implements task #27.

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
 

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<adler32> {
 	
 	void init() { s1 = 1, s2 = 0; }

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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