|
| 1 | +//this is json with single line comments supported |
| 2 | +// QDox config file |
| 3 | +[ |
| 4 | +{ |
| 5 | + "start_path":"..", |
| 6 | + "paths": ["prog/gameLibs"], //folders or files list, required, |
| 7 | + "doc_chapter": "quirrel-modules/quirrel_gamelibs", //internal folder name, required |
| 8 | + "chapter_desc": "Docs for Quirrel modules extracted from source in gameLibs.", //displayed title, optional |
| 9 | + "chapter_title": "Quirrel Gamelibs Native Modules", //displayed title, optional |
| 10 | + "extensions": [".cpp"], //optional, list of extensions of files |
| 11 | + "exclude_dirs_re": [], //optional, list of regexps that should full match to exclude dirs in recursive search |
| 12 | + "exclude_files_re": [], //optional, list of full match regexp to skip files' |
| 13 | + "recursive": true //optional, do recursive search for folders' |
| 14 | +}, |
| 15 | + |
| 16 | +{ |
| 17 | + "start_path":"..", |
| 18 | + "paths": ["prog/gameLibs/ecs/scripts"], //folders or files list, required, |
| 19 | + "doc_chapter": "quirrel-modules/quirrel_daECS", //internal folder name, required |
| 20 | + "chapter_desc": "Docs for Quirrel modules for Dagor ECS.", //displayed title, optional |
| 21 | + "chapter_title": "Quirrel ECS", //displayed title, optional |
| 22 | + "extensions": [".cpp"], //optional, list of extensions of files |
| 23 | + "exclude_dirs_re": [], //optional, list of regexps that should full match to exclude dirs in recursive search |
| 24 | + "exclude_files_re": [], //optional, list of full match regexp to skip files' |
| 25 | + "recursive": true //optional, do recursive search for folders' |
| 26 | +}, |
| 27 | + |
| 28 | +{ |
| 29 | + "start_path":"..", |
| 30 | + "paths": ["prog/gameLibs/daRg"], //folders or files list, required, |
| 31 | + "doc_chapter": "quirrel-modules/darg_framework", //internal folder name, required |
| 32 | + "chapter_desc": "Docs for daRG - Dagor Reactive GUI framework, based on Quirrel language and Functional Reactive Programming (FRP).", //displayed title, optional |
| 33 | + "chapter_desc_files": ["prog/gameLibs/daRg/daRg_readme.rst"], |
| 34 | + "chapter_title": "daRG Framework", //displayed title, optional |
| 35 | + "extensions": [".cpp"], //optional, list of extensions of files |
| 36 | + "exclude_dirs_re": [], //optional, list of regexps that should full match to exclude dirs in recursive search |
| 37 | + "exclude_files_re": [], //optional, list of full match regexp to skip files' |
| 38 | + "recursive": true //optional, do recursive search for folders' |
| 39 | +}, |
| 40 | + |
| 41 | +{ |
| 42 | + "start_path":"..", |
| 43 | + "paths": ["prog/tools/dargbox"], //folders or files list, required, |
| 44 | + "doc_chapter": "tools/dargbox", //internal folder name, required |
| 45 | + "chapter_desc": "Docs for dargbox - daRG utility application and sandbox.", //displayed title, optional |
| 46 | + "chapter_title": "dargbox Tool", //displayed title, optional |
| 47 | + "extensions": [".cpp"], //optional, list of extensions of files |
| 48 | + "exclude_dirs_re": [], //optional, list of regexps that should full match to exclude dirs in recursive search |
| 49 | + "exclude_files_re": [], //optional, list of full match regexp to skip files' |
| 50 | + "recursive": true //optional, do recursive search for folders' |
| 51 | +}, |
| 52 | + |
| 53 | +{ |
| 54 | + "start_path":"..", |
| 55 | + "paths": ["prog/daNetGameLibs"], //folders or files list, required, |
| 56 | + "doc_chapter": "quirrel-modules/daNetGameLibs", //internal folder name, required |
| 57 | + "chapter_desc": "Docs for daNetGameLibs Quirrel Modules. The daNetGameLibs can be used in any daNetGame-based project.", //displayed title, optional |
| 58 | + "chapter_title": "daNetGameLibs", //displayed title, optional |
| 59 | + "extensions": [".cpp"], //optional, list of extensions of files |
| 60 | + "exclude_dirs_re": [], //optional, list of regexps that should full match to exclude dirs in recursive search |
| 61 | + "exclude_files_re": [], //optional, list of full match regexp to skip files' |
| 62 | + "recursive": true //optional, do recursive search for folders' |
| 63 | +}, |
| 64 | + |
| 65 | +{ |
| 66 | + "start_path":"..", |
| 67 | + "paths": ["prog/daNetGame"], //folders or files list, required, |
| 68 | + "doc_chapter": "quirrel-modules/daNetGame", //internal folder name, required |
| 69 | + "chapter_desc": "Docs for daNetGame Quirrel Modules. The daNetGame framework is designed for building games.", //displayed title, optional |
| 70 | + "chapter_title": "daNetGame", //displayed title, optional |
| 71 | + "extensions": [".cpp"], //optional, list of extensions of files |
| 72 | + "exclude_dirs_re": [], //optional, list of regexps that should full match to exclude dirs in recursive search |
| 73 | + "exclude_files_re": [], //optional, list of full match regexp to skip files' |
| 74 | + "recursive": true //optional, do recursive search for folders' |
| 75 | +}, |
| 76 | + |
| 77 | +{ |
| 78 | + "start_path":"..", |
| 79 | + "paths": ["prog/gameLibs/soundSystem/quirrel"], //folders or files list, required, |
| 80 | + "doc_chapter": "quirrel-modules/soundSystem", //internal folder name, required |
| 81 | + "chapter_desc": "Docs for soundSystem Quirrel Modules. The soundSystem can be used in any daNetGame-based project.", //displayed title, optional |
| 82 | + "chapter_title": "soundSystem", //displayed title, optional |
| 83 | + "extensions": [".cpp",".inl"], //optional, list of extensions of files |
| 84 | + "exclude_dirs_re": [], //optional, list of regexps that should full match to exclude dirs in recursive search |
| 85 | + "exclude_files_re": [], //optional, list of full match regexp to skip files' |
| 86 | + "recursive": true //optional, do recursive search for folders' |
| 87 | +} |
| 88 | + |
| 89 | +] |
0 commit comments