publish documentation of PeFile::pack0 method

This commit is contained in:
gogo 2024-12-13 01:59:50 +01:00 committed by Joe
parent 2c79fa4fd0
commit 0ce21ff3d4
2 changed files with 20 additions and 21 deletions

View File

@ -510,7 +510,7 @@ EXTRACT_PRIVATE = YES
# methods of a class will be included in the documentation.
# The default value is: NO.
EXTRACT_PRIV_VIRTUAL = NO
EXTRACT_PRIV_VIRTUAL = YES
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
@ -538,7 +538,7 @@ EXTRACT_LOCAL_CLASSES = YES
# included.
# The default value is: NO.
EXTRACT_LOCAL_METHODS = NO
EXTRACT_LOCAL_METHODS = YES
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
@ -906,7 +906,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = src/pefile.cpp
INPUT = src
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

View File

@ -64,33 +64,32 @@ protected:
/**
* \brief create UPX0 section
*
*
* \param fo
* The OutputFile class to the path where the new file will be created.
*
* \param ih
* Input handler.
* \param :
*
* \param oh
* Output handler.
* \arg fo
* The OutputFile class to the path where the new file will be created.
*
* \param subsystem_mask
* Permission mask for UPX0, UPX1, etc... sections.
*
* \arg ih
* Input PE header. \n \n
* Native windows data structure required by the os to be understood and to make a valid executable. The documentation of this data type is present there: https://www.vergiliusproject.com/kernels/x64/windows-11/23h2/_IMAGE_FILE_HEADER and described there: https://wiki.osdev.org/PE#PE_header.
*
* \arg oh
* Output PE header. \n \n
* Native windows data structure required by the os to be understood and to make a valid executable. The documentation of this data type is present there: https://www.vergiliusproject.com/kernels/x64/windows-11/23h2/_IMAGE_FILE_HEADER and described there: https://wiki.osdev.org/PE#PE_header.
*
* \arg subsystem_mask
* Permission mask for UPX0, UPX1, etc... sections. \n \n
* Number between 0 and 255 to indicate the section permissions of the section UPX0, UPX1, etc...
*
* \param default_imagebase
* Base address of the image base of the process.
*
* \arg default_imagebase
* Base address of the image base of the process. \n \n
* Very first start of where is stored the data and the code run by the OS.
*
* \param last_section_rsrc_only
* true if
* \arg last_section_rsrc_only
* This is true when the last PE section of the compressed file must only contain resources and must be called "rsrc"
*
* \return void, in any circonstance.
*
*
**/
template <typename LEXX, typename ht> void pack0(OutputFile *fo, ht &ih, ht &oh, unsigned subsystem_mask, upx_uint64_t default_imagebase, bool last_section_rsrc_only);