[NOBIN] Added comments for Doxygen

This commit is contained in:
hasherezade
2021-08-02 11:06:26 +02:00
parent 0ca0976d87
commit 36f6d412b7
5 changed files with 19 additions and 3 deletions
+5
View File
@@ -1,3 +1,8 @@
/**
* @file
* @brief The API: definitions of the exported elements that are accessible from PE-sieve DLL.
*/
#pragma once
#include <windows.h>
+6 -1
View File
@@ -1,8 +1,13 @@
/**
* @file
* @brief The codes returned by the PE-sieve EXE
*/
#pragma once
// return codes for PE-sieve.exe:
typedef enum {
PESIEVE_ERROR = (-1), ///< PE-sieve returned error
PESIEVE_ERROR = (-1), ///< the scan has failed, PE-sieve returned an error
PESIEVE_INFO = 0, ///< PE-sieve was deployed in the info mode (i.e. displaying help)
PESIEVE_NOT_DETECTED = 1, ///< the process was scanned successfuly, and NO suspicious indicators are detected
PESIEVE_DETECTED = 2 ///< the process was scanned successfuly, and some suspicious indicators are detected
+5 -1
View File
@@ -1,7 +1,11 @@
/**
* @file
* @brief The types used by PE-sieve API.
*/
#pragma once
#include <windows.h>
#include <pshpack4.h> // ensure 4 byte packing of the structures
#define MAX_MODULE_BUF_LEN 1024
+2 -1
View File
@@ -5,10 +5,11 @@
namespace pesieve {
//! Process the list of collected patches, and for those of them that were detected as hooks, it resolves information to which modules do they lead to.
class HookTargetResolver
{
public:
HookTargetResolver(ProcessScanReport& process_report)
HookTargetResolver(IN ProcessScanReport& process_report)
: processReport(process_report)
{
}
+1
View File
@@ -7,6 +7,7 @@
namespace pesieve {
//! A report from an IAT scan, generated by IATScanner
class IATScanReport : public ModuleScanReport
{
public: