Documentation of results/mod.rs

[Razican]

Most of the code is still not documented. This is the tracking issue for results/mod.rs file documentation.

• Module level documentation.
• Results struct:
  • init() function.
  • set_certificate() function.
  • set_app_package() function.
  • set_app_label() function.
  • set_app_description() function.
  • set_app_version() function.
  • set_app_version_num() function.
  • set_app_min_sdk() function.
  • set_app_target_sdk() function.
  • add_vulnerability() function.
  • add_benchmark() function.
  • get_benchmarks() function.
  • generate_report() function:
    • Function level documentation.
    • Inline comments.
  • generate_json_report() function:
    • Function level documentation.
    • Inline comments.
  • generate_html_report() function:
    • Function level documentation.
    • Inline comments.
  • print_html_vuln_set() function:
    • Function level documentation.
    • Inline comments.
  • generate_code_html_files() function:
    • Function level documentation.
    • Inline comments.
  • generate_code_html_folder() function:
    • Function level documentation.
    • Inline comments.
  • generate_html_src_menu() function:
    • Function level documentation.
    • Inline comments.
  • generate_code_html_for() function:
    • Function level documentation.
    • Inline comments.
  • html_escape() function.