Skip to content
This repository has been archived by the owner on Feb 16, 2024. It is now read-only.

Documentation of config.rs #55

Closed
47 tasks done
Razican opened this issue Oct 9, 2016 · 0 comments
Closed
47 tasks done

Documentation of config.rs #55

Razican opened this issue Oct 9, 2016 · 0 comments

Comments

@Razican
Copy link
Member

Razican commented Oct 9, 2016

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

  • Module level documentation.
  • Config struct:
    • Struct level documentation.
    • new() function:
      • Unix target.
      • Windows target.
    • check() function.
    • get_errors() function.
    • get_loaded_config_files() function.
    • get_app_package() function.
    • is_verbose() function.
    • is_quiet() function.
    • is_force() function.
    • is_bench() function.
    • is_open() function.
    • get_threads() function.
    • get_downloads_folder() function.
    • get_dist_folder() function.
    • get_results_folder() function.
    • get_dex2jar_folder() function.
    • get_jd_cmd_file() function.
    • get_template_path() function:
      • Unix target.
      • Windows target.
    • get_templates_folder() function.
    • get_template_name() function.
    • get_rules_json() function.
    • get_unknown_permission_criticity() function.
    • get_unknown_permission_description() function.
    • get_permissions() function.
    • load_from_file() function:
      • Function level documentation.
      • Inline comments.
  • PermissionConfig struct:
    • Struct level documentation.
    • new() function.
    • get_permission() function.
    • get_criticity() function.
    • get_label() function.
    • get_description() function.
  • Tests:
    • it_config() function:
      • Function level documentation.
      • Inline comments.
    • it_config_sample() function:
      • Function level documentation.
      • Inline comments.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant