diff --git a/include/payload_file_reader.h b/include/payload_file_reader.h index 253af62..f36da91 100644 --- a/include/payload_file_reader.h +++ b/include/payload_file_reader.h @@ -3,7 +3,19 @@ #include -class payload_file_reader { +/** + * This class can read gameboy payloads from the files that were generated by payload_file_writer in + * the data-generator subproject. + * + * The format stores the base payload metadata alongside the base payload first, and then stores + * other payload metadata alongside binary patches to convert the base payload into that payload. + * + * This way we avoid storing redundancy in the data. + * + * Anyway, this class can extract the desired payload from that file format. + */ +class payload_file_reader +{ public: payload_file_reader(const uint8_t *file_buffer, uint16_t buffer_size); diff --git a/tools/data-generator/include/payloads/payload_file_reader.h b/tools/data-generator/include/payloads/payload_file_reader.h index 253af62..808e5df 100644 --- a/tools/data-generator/include/payloads/payload_file_reader.h +++ b/tools/data-generator/include/payloads/payload_file_reader.h @@ -3,6 +3,17 @@ #include +/** + * This class can read gameboy payloads from the files that were generated by payload_file_writer in + * the data-generator subproject. + * + * The format stores the base payload metadata alongside the base payload first, and then stores + * other payload metadata alongside binary patches to convert the base payload into that payload. + * + * This way we avoid storing redundancy in the data. + * + * Anyway, this class can extract the desired payload from that file format. + */ class payload_file_reader { public: payload_file_reader(const uint8_t *file_buffer, uint16_t buffer_size);