2
0

Md5Sum.3 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. .TH "Md5Sum" 3 "Tue Aug 9 2022" "openPilotLog" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. Md5Sum \- The \fBMd5Sum\fP class is responsible for calculating cryptographic hashes of files (used to verify downloads)
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <md5sum\&.h>\fP
  11. .SS "Public Member Functions"
  12. .in +1c
  13. .ti -1c
  14. .RI "\fBMd5Sum\fP (QFileInfo &file_info)"
  15. .br
  16. .RI "AHash - calculates the MD5-checksum for the input file specified in the constructor and saves the result in the checksum member variable\&. "
  17. .ti -1c
  18. .RI "const QString \fBhashToHex\fP () const"
  19. .br
  20. .RI "hashString returns a hex representation of the hash "
  21. .ti -1c
  22. .RI "bool \fBcompare\fP (QFileInfo &md5_file) const"
  23. .br
  24. .RI "compare reads the pre-calculated md5-sum from a checkfile and compares the hashes\&. "
  25. .in -1c
  26. .SS "Public Attributes"
  27. .in +1c
  28. .ti -1c
  29. .RI "QByteArray \fBchecksum\fP"
  30. .br
  31. .in -1c
  32. .SH "Detailed Description"
  33. .PP
  34. The \fBMd5Sum\fP class is responsible for calculating cryptographic hashes of files (used to verify downloads)
  35. .SH "Member Function Documentation"
  36. .PP
  37. .SS "bool Md5Sum::compare (QFileInfo & md5_file) const"
  38. .PP
  39. compare reads the pre-calculated md5-sum from a checkfile and compares the hashes\&.
  40. .PP
  41. \fBParameters\fP
  42. .RS 4
  43. \fImd5_file\fP - the checkfile containing the md5 checksum in hex format
  44. .RE
  45. .PP
  46. \fBReturns\fP
  47. .RS 4
  48. true if hashes match
  49. .RE
  50. .PP
  51. .SH "Author"
  52. .PP
  53. Generated automatically by Doxygen for openPilotLog from the source code\&.