Merge branch 'bugfix/esp_err_ignore_dirs' into 'master'

esp32: Do not document error codes defined in examples

See merge request idf/esp-idf!2732
This commit is contained in:
Angus Gratton
2018-07-18 08:29:53 +08:00
2 changed files with 4 additions and 8 deletions

View File

@@ -25,6 +25,9 @@ import textwrap
# list files here which should not be parsed
ignore_files = [ 'components/mdns/test_afl_fuzz_host/esp32_compat.h' ]
# add directories here which should not be parsed
ignore_dirs = ( 'examples' )
# macros from here have higher priorities in case of collisions
priority_headers = [ 'components/esp32/include/esp_err.h' ]
@@ -292,7 +295,7 @@ def main():
for filename in fnmatch.filter(filenames, '*.[ch]'):
full_path = os.path.join(root, filename)
path_in_idf = os.path.relpath(full_path, idf_path)
if path_in_idf in ignore_files:
if path_in_idf in ignore_files or path_in_idf.startswith(ignore_dirs):
continue
with open(full_path, "r+") as f:
for line in f: