diff options
author | Nino van Hooff <ninovanhooff@gmail.com> | 2020-05-28 18:13:44 +0300 |
---|---|---|
committer | Nino van Hooff <ninovanhooff@gmail.com> | 2020-05-28 18:13:44 +0300 |
commit | c2c96faf5fcbad942f8cf257e75c94a623ac5eaa (patch) | |
tree | 80595e95c11b0c6a3c96cf26ce5eb0582c3141b7 /cmake | |
parent | fe779d95016333d99190034ece2869ec7e0b92a1 (diff) |
Convert remaining doxygen to rst
Diffstat (limited to 'cmake')
-rwxr-xr-x | cmake/mod_bundled_packages_json.py | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/cmake/mod_bundled_packages_json.py b/cmake/mod_bundled_packages_json.py index 6423591f57..66038b30e2 100755 --- a/cmake/mod_bundled_packages_json.py +++ b/cmake/mod_bundled_packages_json.py @@ -11,11 +11,13 @@ import os import sys -## Finds all JSON files in the given directory recursively and returns a list of those files in absolute paths. -# -# \param work_dir The directory to look for JSON files recursively. -# \return A list of JSON files in absolute paths that are found in the given directory. def find_json_files(work_dir: str) -> list: + """Finds all JSON files in the given directory recursively and returns a list of those files in absolute paths. + + :param work_dir: The directory to look for JSON files recursively. + :return: A list of JSON files in absolute paths that are found in the given directory. + """ + json_file_list = [] for root, dir_names, file_names in os.walk(work_dir): for file_name in file_names: @@ -24,12 +26,14 @@ def find_json_files(work_dir: str) -> list: return json_file_list -## Removes the given entries from the given JSON file. The file will modified in-place. -# -# \param file_path The JSON file to modify. -# \param entries A list of strings as entries to remove. -# \return None def remove_entries_from_json_file(file_path: str, entries: list) -> None: + """Removes the given entries from the given JSON file. The file will modified in-place. + + :param file_path: The JSON file to modify. + :param entries: A list of strings as entries to remove. + :return: None + """ + try: with open(file_path, "r", encoding = "utf-8") as f: package_dict = json.load(f, object_hook = collections.OrderedDict) |