From 7b9ababc11394091f727656725fae3de75a9978d Mon Sep 17 00:00:00 2001 From: Lipu Fei Date: Tue, 29 Oct 2019 11:14:49 +0100 Subject: [PATCH] Use Doxygen-style docs CURA-6557 --- cmake/mod_bundled_packages_json.py | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/cmake/mod_bundled_packages_json.py b/cmake/mod_bundled_packages_json.py index 8a33f88a5a..6423591f57 100755 --- a/cmake/mod_bundled_packages_json.py +++ b/cmake/mod_bundled_packages_json.py @@ -11,12 +11,11 @@ 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: @@ -25,13 +24,12 @@ 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)