From e68eec06a3df66025c5ab89bd8a9b16884bdfc21 Mon Sep 17 00:00:00 2001 From: <> Date: Mon, 19 Feb 2024 20:51:13 +0000 Subject: [PATCH] Deployed 4afc01f with MkDocs version: 1.5.3 --- .nojekyll | 0 404.html | 859 ++ CHANGELOG/index.html | 1266 ++ Doxyfile | 2811 ++++ E2E/OrgProfile.odt | Bin 0 -> 49025 bytes E2E/ProjectsProfile.odt | Bin 0 -> 64771 bytes E2E/UserProfile.odt | Bin 0 -> 51618 bytes LICENSE/index.html | 1812 +++ Makefile | 54 + about/index.html | 1043 ++ api/index.html | 11827 ++++++++++++++++ apidocs/html/____init_____8py_source.html | 80 + apidocs/html/____version_____8py_source.html | 81 + apidocs/html/annotated.html | 108 + apidocs/html/bc_s.png | Bin 0 -> 676 bytes apidocs/html/bdwn.png | Bin 0 -> 147 bytes apidocs/html/campaigns_8py_source.html | 241 + ...classcampaigns_1_1CampaignsDB-members.html | 88 + .../html/classcampaigns_1_1CampaignsDB.html | 230 + ...scampaigns_1_1CampaignsDB__coll__graph.dot | 9 + ...mpaigns_1_1CampaignsDB__inherit__graph.dot | 9 + .../classdbsupport_1_1DBSupport-members.html | 104 + apidocs/html/classdbsupport_1_1DBSupport.html | 795 ++ ...assdbsupport_1_1DBSupport__coll__graph.dot | 9 + ...dbsupport_1_1DBSupport__inherit__graph.dot | 9 + ...901c45b2922502eca4d985df18e1137_cgraph.dot | 10 + ...3958bd07794c43ae6d0001fcac5871_icgraph.dot | 12 + ...2a389978dc47e166bd8ecd1e9fdb1a_icgraph.dot | 14 + ...192123198f34ba4b1e32ab2ea3c8396_cgraph.dot | 10 + ...f54b36d9a7d2ff96e7a1d32198257f_icgraph.dot | 14 + apidocs/html/classes.html | 105 + .../classgenerator_1_1Generator-members.html | 96 + apidocs/html/classgenerator_1_1Generator.html | 436 + ...assgenerator_1_1Generator__coll__graph.dot | 9 + ...generator_1_1Generator__inherit__graph.dot | 9 + ...aa8837803e7bffd62f976b077343a8d_cgraph.dot | 18 + ...637ca5bb0c0adf0ccee74f41c4189c_icgraph.dot | 12 + ...a90b19c3df93fa16e9595ccc4841c5_icgraph.dot | 12 + ...2b33a0bf038ab6d675f38ca2eada72_icgraph.dot | 12 + ...f6186289f219ae9a6af9bbf99672a7_icgraph.dot | 12 + ...cd126a3a51069384a3bf7627401ca45_cgraph.dot | 16 + ...d126a3a51069384a3bf7627401ca45_icgraph.dot | 10 + ...anizations_1_1OrganizationsDB-members.html | 87 + ...classorganizations_1_1OrganizationsDB.html | 193 + ...ations_1_1OrganizationsDB__coll__graph.dot | 9 + ...ons_1_1OrganizationsDB__inherit__graph.dot | 9 + .../classprojects_1_1ProjectsDB-members.html | 93 + apidocs/html/classprojects_1_1ProjectsDB.html | 222 + ...assprojects_1_1ProjectsDB__coll__graph.dot | 9 + ...projects_1_1ProjectsDB__inherit__graph.dot | 9 + ...d4ca8b98d80895a97ea866ee3422d27_cgraph.dot | 30 + .../html/classproto_1_1ProtoBuf-members.html | 86 + apidocs/html/classproto_1_1ProtoBuf.html | 225 + .../classproto_1_1ProtoBuf__coll__graph.dot | 9 + ...classproto_1_1ProtoBuf__inherit__graph.dot | 9 + .../html/classtasks_1_1TasksDB-members.html | 87 + apidocs/html/classtasks_1_1TasksDB.html | 280 + .../classtasks_1_1TasksDB__coll__graph.dot | 9 + .../classtasks_1_1TasksDB__inherit__graph.dot | 9 + ...abb2c1ae17b51d72288486649949ac_icgraph.dot | 12 + ...a80579b7d1f2028ea5a47144ee6c146_cgraph.dot | 10 + ...4b6916d3d368b484099d5d2a0bbde1d_cgraph.dot | 10 + .../html/classteams_1_1TeamsDB-members.html | 87 + apidocs/html/classteams_1_1TeamsDB.html | 158 + .../classteams_1_1TeamsDB__coll__graph.dot | 9 + .../classteams_1_1TeamsDB__inherit__graph.dot | 9 + ...dmin__manage_1_1TmAdminManage-members.html | 94 + ...classtmadmin__manage_1_1TmAdminManage.html | 438 + ...__manage_1_1TmAdminManage__coll__graph.dot | 9 + ...anage_1_1TmAdminManage__inherit__graph.dot | 9 + ...ce654c77614118620958b2bb8d8d5f_icgraph.dot | 10 + ...e2c378e714adf64beeb922a4431b28_icgraph.dot | 12 + ...48561726ee5abc6f0ad12c2c6e418cf_cgraph.dot | 10 + .../classtmclient_1_1TMClient-members.html | 89 + apidocs/html/classtmclient_1_1TMClient.html | 247 + ...classtmclient_1_1TMClient__coll__graph.dot | 9 + ...sstmclient_1_1TMClient__inherit__graph.dot | 9 + ...be43ead01d39949747251d84f796319_cgraph.dot | 12 + ...c8cab892d16a8c7b961509e7304bd1_icgraph.dot | 12 + .../html/classtmdb_1_1TMImport-members.html | 95 + apidocs/html/classtmdb_1_1TMImport.html | 379 + .../classtmdb_1_1TMImport__coll__graph.dot | 9 + .../classtmdb_1_1TMImport__inherit__graph.dot | 9 + ...aed14fd58585480c971504a5fef5fc_icgraph.dot | 10 + ...8a3419014e5b6bdffecef12aaa79b2_icgraph.dot | 12 + ...a4f362d2d50f3b6d589875c21ca790e_cgraph.dot | 10 + ...sstmserver_1_1RequestServicer-members.html | 91 + .../classtmserver_1_1RequestServicer.html | 129 + ...server_1_1RequestServicer__coll__graph.dot | 9 + ...ver_1_1RequestServicer__inherit__graph.dot | 9 + .../classtmserver_1_1TMServer-members.html | 85 + apidocs/html/classtmserver_1_1TMServer.html | 199 + ...classtmserver_1_1TMServer__coll__graph.dot | 9 + ...sstmserver_1_1TMServer__inherit__graph.dot | 9 + ...1d5ad0dab82d9af80c5e7a9a65d62c_icgraph.dot | 12 + ...776ecdbd12903199f91c141f8a120c8_cgraph.dot | 12 + .../html/classusers_1_1UsersDB-members.html | 94 + apidocs/html/classusers_1_1UsersDB.html | 487 + .../classusers_1_1UsersDB__coll__graph.dot | 9 + .../classusers_1_1UsersDB__inherit__graph.dot | 9 + ...11a51d70fea3b4a3691a6ddc7e24b84_cgraph.dot | 22 + ...8c38de764ffd4f0ef70c5b7c8f00574_cgraph.dot | 10 + ...55686dd986eae2f74bcef6dc99cdc0_icgraph.dot | 10 + ...d18dcb81055343c7f9175cde58b1ec8_cgraph.dot | 10 + ...39c1569a06030f772b69312d2c8f274_cgraph.dot | 10 + ...4e045ee980fc37a826cc3dd10c892ce_cgraph.dot | 10 + ...3dd5c5c9d13b55ec32a0da26a06f2c_icgraph.dot | 12 + .../classyamlfile_1_1YamlFile-members.html | 89 + apidocs/html/classyamlfile_1_1YamlFile.html | 204 + ...classyamlfile_1_1YamlFile__coll__graph.dot | 9 + ...ssyamlfile_1_1YamlFile__inherit__graph.dot | 9 + apidocs/html/closed.png | Bin 0 -> 132 bytes apidocs/html/conftest_8py_source.html | 110 + apidocs/html/dbsupport_8py_source.html | 583 + .../dir_2751e589abeffcf20ff2eeb9e2122732.html | 79 + .../dir_348505f96b956caabe4d74ae5673ffa6.html | 83 + .../dir_59425e443f801f1f2fd8bbe4959a3ccf.html | 79 + .../dir_6b7046e8fbf7bd9518c790550f41f091.html | 79 + .../dir_6c545ee20ee14f97d8c93898dd491633.html | 79 + .../dir_7aca4abf2cce35acb34fbbecc6101047.html | 79 + .../dir_8b847e7567b96db9dee2188b16d3384b.html | 79 + .../dir_fa7605c3f87aadbdcc71b9200f5eb483.html | 79 + apidocs/html/doc.png | Bin 0 -> 746 bytes apidocs/html/doxygen.css | 1793 +++ apidocs/html/doxygen.svg | 26 + apidocs/html/dynsections.js | 128 + apidocs/html/files.html | 116 + apidocs/html/folderclosed.png | Bin 0 -> 616 bytes apidocs/html/folderopen.png | Bin 0 -> 597 bytes apidocs/html/functions.html | 295 + apidocs/html/functions_func.html | 295 + apidocs/html/generator_8py_source.html | 529 + apidocs/html/graph_legend.dot | 23 + apidocs/html/graph_legend.html | 135 + apidocs/html/hierarchy.html | 99 + apidocs/html/index.html | 75 + apidocs/html/inherit_graph_0.dot | 20 + apidocs/html/inherit_graph_1.dot | 24 + apidocs/html/inherit_graph_2.dot | 10 + apidocs/html/inherits.html | 85 + apidocs/html/jquery.js | 35 + ..._tm_admin_tm_admin_tm_admin_CHANGELOG.html | 352 + apidocs/html/menu.js | 51 + apidocs/html/menudata.js | 60 + apidocs/html/namespaces.html | 111 + apidocs/html/namespacestrong.html | 80 + apidocs/html/namespacetests.html | 76 + apidocs/html/nav_f.png | Bin 0 -> 153 bytes apidocs/html/nav_g.png | Bin 0 -> 95 bytes apidocs/html/nav_h.png | Bin 0 -> 98 bytes apidocs/html/open.png | Bin 0 -> 123 bytes apidocs/html/organizations_8py_source.html | 207 + apidocs/html/pages.html | 80 + apidocs/html/projects_8py_source.html | 501 + apidocs/html/proto_8py_source.html | 275 + apidocs/html/search/all_0.html | 37 + apidocs/html/search/all_0.js | 4 + apidocs/html/search/all_1.html | 37 + apidocs/html/search/all_1.js | 5 + apidocs/html/search/all_2.html | 37 + apidocs/html/search/all_2.js | 18 + apidocs/html/search/all_3.html | 37 + apidocs/html/search/all_3.js | 6 + apidocs/html/search/all_4.html | 37 + apidocs/html/search/all_4.js | 16 + apidocs/html/search/all_5.html | 37 + apidocs/html/search/all_5.js | 5 + apidocs/html/search/all_6.html | 37 + apidocs/html/search/all_6.js | 4 + apidocs/html/search/all_7.html | 37 + apidocs/html/search/all_7.js | 11 + apidocs/html/search/all_8.html | 37 + apidocs/html/search/all_8.js | 4 + apidocs/html/search/all_9.html | 37 + apidocs/html/search/all_9.js | 5 + apidocs/html/search/all_a.html | 37 + apidocs/html/search/all_a.js | 9 + apidocs/html/search/all_b.html | 37 + apidocs/html/search/all_b.js | 5 + apidocs/html/search/all_c.html | 37 + apidocs/html/search/all_c.js | 10 + apidocs/html/search/all_d.html | 37 + apidocs/html/search/all_d.js | 11 + apidocs/html/search/all_e.html | 37 + apidocs/html/search/all_e.js | 4 + apidocs/html/search/classes_0.html | 37 + apidocs/html/search/classes_0.js | 4 + apidocs/html/search/classes_1.html | 37 + apidocs/html/search/classes_1.js | 4 + apidocs/html/search/classes_2.html | 37 + apidocs/html/search/classes_2.js | 4 + apidocs/html/search/classes_3.html | 37 + apidocs/html/search/classes_3.js | 4 + apidocs/html/search/classes_4.html | 37 + apidocs/html/search/classes_4.js | 5 + apidocs/html/search/classes_5.html | 37 + apidocs/html/search/classes_5.js | 4 + apidocs/html/search/classes_6.html | 37 + apidocs/html/search/classes_6.js | 9 + apidocs/html/search/classes_7.html | 37 + apidocs/html/search/classes_7.js | 4 + apidocs/html/search/classes_8.html | 37 + apidocs/html/search/classes_8.js | 4 + apidocs/html/search/close.svg | 31 + apidocs/html/search/functions_0.html | 37 + apidocs/html/search/functions_0.js | 4 + apidocs/html/search/functions_1.html | 37 + apidocs/html/search/functions_1.js | 5 + apidocs/html/search/functions_2.html | 37 + apidocs/html/search/functions_2.js | 17 + apidocs/html/search/functions_3.html | 37 + apidocs/html/search/functions_3.js | 5 + apidocs/html/search/functions_4.html | 37 + apidocs/html/search/functions_4.js | 15 + apidocs/html/search/functions_5.html | 37 + apidocs/html/search/functions_5.js | 5 + apidocs/html/search/functions_6.html | 37 + apidocs/html/search/functions_6.js | 4 + apidocs/html/search/functions_7.html | 37 + apidocs/html/search/functions_7.js | 11 + apidocs/html/search/functions_8.html | 37 + apidocs/html/search/functions_8.js | 8 + apidocs/html/search/functions_9.html | 37 + apidocs/html/search/functions_9.js | 4 + apidocs/html/search/functions_a.html | 37 + apidocs/html/search/functions_a.js | 9 + apidocs/html/search/mag_sel.svg | 74 + apidocs/html/search/namespaces_0.html | 37 + apidocs/html/search/namespaces_0.js | 4 + apidocs/html/search/namespaces_1.html | 37 + apidocs/html/search/namespaces_1.js | 4 + apidocs/html/search/nomatches.html | 13 + apidocs/html/search/pages_0.html | 37 + apidocs/html/search/pages_0.js | 4 + apidocs/html/search/search.css | 257 + apidocs/html/search/search.js | 816 ++ apidocs/html/search/search_l.png | Bin 0 -> 567 bytes apidocs/html/search/search_m.png | Bin 0 -> 158 bytes apidocs/html/search/search_r.png | Bin 0 -> 553 bytes apidocs/html/search/searchdata.js | 27 + apidocs/html/splitbar.png | Bin 0 -> 314 bytes apidocs/html/sync_off.png | Bin 0 -> 853 bytes apidocs/html/sync_on.png | Bin 0 -> 845 bytes apidocs/html/tab_a.png | Bin 0 -> 142 bytes apidocs/html/tab_b.png | Bin 0 -> 169 bytes apidocs/html/tab_h.png | Bin 0 -> 177 bytes apidocs/html/tab_s.png | Bin 0 -> 184 bytes apidocs/html/tabs.css | 1 + apidocs/html/tasks_8py_source.html | 517 + apidocs/html/teams_8py_source.html | 223 + apidocs/html/test__campaigns_8py_source.html | 245 + apidocs/html/test__dbsupport_8py_source.html | 132 + apidocs/html/test__messages_8py_source.html | 322 + .../html/test__notifications_8py_source.html | 155 + apidocs/html/test__orgs_8py_source.html | 280 + .../html/test__placeholder_8py_source.html | 107 + apidocs/html/test__projects_8py_source.html | 545 + apidocs/html/test__tasks_8py_source.html | 296 + apidocs/html/test__teams_8py_source.html | 293 + apidocs/html/test__users_8py_source.html | 499 + apidocs/html/test__validation_8py_source.html | 291 + apidocs/html/test__yamlfile_8py_source.html | 156 + apidocs/html/tmadmin__manage_8py_source.html | 423 + apidocs/html/tmclient_8py_source.html | 258 + apidocs/html/tmdb_8py_source.html | 542 + apidocs/html/tmserver_8py_source.html | 396 + apidocs/html/users_8py_source.html | 525 + apidocs/html/yamlfile_8py_source.html | 199 + assets/_mkdocstrings.css | 64 + assets/images/favicon.png | Bin 0 -> 1870 bytes assets/javascripts/bundle.aecac24b.min.js | 29 + assets/javascripts/bundle.aecac24b.min.js.map | 7 + assets/javascripts/lunr/min/lunr.ar.min.js | 1 + assets/javascripts/lunr/min/lunr.da.min.js | 18 + assets/javascripts/lunr/min/lunr.de.min.js | 18 + assets/javascripts/lunr/min/lunr.du.min.js | 18 + assets/javascripts/lunr/min/lunr.el.min.js | 1 + assets/javascripts/lunr/min/lunr.es.min.js | 18 + assets/javascripts/lunr/min/lunr.fi.min.js | 18 + assets/javascripts/lunr/min/lunr.fr.min.js | 18 + assets/javascripts/lunr/min/lunr.he.min.js | 1 + assets/javascripts/lunr/min/lunr.hi.min.js | 1 + assets/javascripts/lunr/min/lunr.hu.min.js | 18 + assets/javascripts/lunr/min/lunr.hy.min.js | 1 + assets/javascripts/lunr/min/lunr.it.min.js | 18 + assets/javascripts/lunr/min/lunr.ja.min.js | 1 + assets/javascripts/lunr/min/lunr.jp.min.js | 1 + assets/javascripts/lunr/min/lunr.kn.min.js | 1 + assets/javascripts/lunr/min/lunr.ko.min.js | 1 + assets/javascripts/lunr/min/lunr.multi.min.js | 1 + assets/javascripts/lunr/min/lunr.nl.min.js | 18 + assets/javascripts/lunr/min/lunr.no.min.js | 18 + assets/javascripts/lunr/min/lunr.pt.min.js | 18 + assets/javascripts/lunr/min/lunr.ro.min.js | 18 + assets/javascripts/lunr/min/lunr.ru.min.js | 18 + assets/javascripts/lunr/min/lunr.sa.min.js | 1 + .../lunr/min/lunr.stemmer.support.min.js | 1 + assets/javascripts/lunr/min/lunr.sv.min.js | 18 + assets/javascripts/lunr/min/lunr.ta.min.js | 1 + assets/javascripts/lunr/min/lunr.te.min.js | 1 + assets/javascripts/lunr/min/lunr.th.min.js | 1 + assets/javascripts/lunr/min/lunr.tr.min.js | 18 + assets/javascripts/lunr/min/lunr.vi.min.js | 1 + assets/javascripts/lunr/min/lunr.zh.min.js | 1 + assets/javascripts/lunr/tinyseg.js | 206 + assets/javascripts/lunr/wordcut.js | 6708 +++++++++ .../workers/search.f886a092.min.js | 42 + .../workers/search.f886a092.min.js.map | 7 + assets/stylesheets/main.35e1ed30.min.css | 1 + assets/stylesheets/main.35e1ed30.min.css.map | 1 + assets/stylesheets/palette.356b1318.min.css | 1 + .../stylesheets/palette.356b1318.min.css.map | 1 + build/index.html | 1076 ++ communication/index.html | 1210 ++ configuring/index.html | 947 ++ css/extra.css | 5 + dataexchange/index.html | 989 ++ dataflow/index.html | 1152 ++ endpoints/index.html | 1445 ++ generator/index.html | 972 ++ getting_started/index.html | 1151 ++ images/favicon.png | Bin 0 -> 1225 bytes images/hot_logo.png | Bin 0 -> 3789 bytes importing/index.html | 940 ++ index.html | 1112 ++ objects.inv | Bin 0 -> 874 bytes protos-api/index.html | 3250 +++++ schema/index.html | 1133 ++ search/search_index.json | 1 + sitemap.xml | 103 + sitemap.xml.gz | Bin 0 -> 358 bytes tmadmin-manage/index.html | 926 ++ tmdb/index.html | 978 ++ tmschema/index.html | 1095 ++ wiki_redirect/index.html | 892 ++ 335 files changed, 69782 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 CHANGELOG/index.html create mode 100644 Doxyfile create mode 100644 E2E/OrgProfile.odt create mode 100644 E2E/ProjectsProfile.odt create mode 100644 E2E/UserProfile.odt create mode 100644 LICENSE/index.html create mode 100644 Makefile create mode 100644 about/index.html create mode 100644 api/index.html create mode 100644 apidocs/html/____init_____8py_source.html create mode 100644 apidocs/html/____version_____8py_source.html create mode 100644 apidocs/html/annotated.html create mode 100644 apidocs/html/bc_s.png create mode 100644 apidocs/html/bdwn.png create mode 100644 apidocs/html/campaigns_8py_source.html create mode 100644 apidocs/html/classcampaigns_1_1CampaignsDB-members.html create mode 100644 apidocs/html/classcampaigns_1_1CampaignsDB.html create mode 100644 apidocs/html/classcampaigns_1_1CampaignsDB__coll__graph.dot create mode 100644 apidocs/html/classcampaigns_1_1CampaignsDB__inherit__graph.dot create mode 100644 apidocs/html/classdbsupport_1_1DBSupport-members.html create mode 100644 apidocs/html/classdbsupport_1_1DBSupport.html create mode 100644 apidocs/html/classdbsupport_1_1DBSupport__coll__graph.dot create mode 100644 apidocs/html/classdbsupport_1_1DBSupport__inherit__graph.dot create mode 100644 apidocs/html/classdbsupport_1_1DBSupport_a3901c45b2922502eca4d985df18e1137_cgraph.dot create mode 100644 apidocs/html/classdbsupport_1_1DBSupport_a423958bd07794c43ae6d0001fcac5871_icgraph.dot create mode 100644 apidocs/html/classdbsupport_1_1DBSupport_a792a389978dc47e166bd8ecd1e9fdb1a_icgraph.dot create mode 100644 apidocs/html/classdbsupport_1_1DBSupport_aa192123198f34ba4b1e32ab2ea3c8396_cgraph.dot create mode 100644 apidocs/html/classdbsupport_1_1DBSupport_acbf54b36d9a7d2ff96e7a1d32198257f_icgraph.dot create mode 100644 apidocs/html/classes.html create mode 100644 apidocs/html/classgenerator_1_1Generator-members.html create mode 100644 apidocs/html/classgenerator_1_1Generator.html create mode 100644 apidocs/html/classgenerator_1_1Generator__coll__graph.dot create mode 100644 apidocs/html/classgenerator_1_1Generator__inherit__graph.dot create mode 100644 apidocs/html/classgenerator_1_1Generator_a2aa8837803e7bffd62f976b077343a8d_cgraph.dot create mode 100644 apidocs/html/classgenerator_1_1Generator_a38637ca5bb0c0adf0ccee74f41c4189c_icgraph.dot create mode 100644 apidocs/html/classgenerator_1_1Generator_acba90b19c3df93fa16e9595ccc4841c5_icgraph.dot create mode 100644 apidocs/html/classgenerator_1_1Generator_ad02b33a0bf038ab6d675f38ca2eada72_icgraph.dot create mode 100644 apidocs/html/classgenerator_1_1Generator_af1f6186289f219ae9a6af9bbf99672a7_icgraph.dot create mode 100644 apidocs/html/classgenerator_1_1Generator_afcd126a3a51069384a3bf7627401ca45_cgraph.dot create mode 100644 apidocs/html/classgenerator_1_1Generator_afcd126a3a51069384a3bf7627401ca45_icgraph.dot create mode 100644 apidocs/html/classorganizations_1_1OrganizationsDB-members.html create mode 100644 apidocs/html/classorganizations_1_1OrganizationsDB.html create mode 100644 apidocs/html/classorganizations_1_1OrganizationsDB__coll__graph.dot create mode 100644 apidocs/html/classorganizations_1_1OrganizationsDB__inherit__graph.dot create mode 100644 apidocs/html/classprojects_1_1ProjectsDB-members.html create mode 100644 apidocs/html/classprojects_1_1ProjectsDB.html create mode 100644 apidocs/html/classprojects_1_1ProjectsDB__coll__graph.dot create mode 100644 apidocs/html/classprojects_1_1ProjectsDB__inherit__graph.dot create mode 100644 apidocs/html/classprojects_1_1ProjectsDB_afd4ca8b98d80895a97ea866ee3422d27_cgraph.dot create mode 100644 apidocs/html/classproto_1_1ProtoBuf-members.html create mode 100644 apidocs/html/classproto_1_1ProtoBuf.html create mode 100644 apidocs/html/classproto_1_1ProtoBuf__coll__graph.dot create mode 100644 apidocs/html/classproto_1_1ProtoBuf__inherit__graph.dot create mode 100644 apidocs/html/classtasks_1_1TasksDB-members.html create mode 100644 apidocs/html/classtasks_1_1TasksDB.html create mode 100644 apidocs/html/classtasks_1_1TasksDB__coll__graph.dot create mode 100644 apidocs/html/classtasks_1_1TasksDB__inherit__graph.dot create mode 100644 apidocs/html/classtasks_1_1TasksDB_a02abb2c1ae17b51d72288486649949ac_icgraph.dot create mode 100644 apidocs/html/classtasks_1_1TasksDB_aba80579b7d1f2028ea5a47144ee6c146_cgraph.dot create mode 100644 apidocs/html/classtasks_1_1TasksDB_ac4b6916d3d368b484099d5d2a0bbde1d_cgraph.dot create mode 100644 apidocs/html/classteams_1_1TeamsDB-members.html create mode 100644 apidocs/html/classteams_1_1TeamsDB.html create mode 100644 apidocs/html/classteams_1_1TeamsDB__coll__graph.dot create mode 100644 apidocs/html/classteams_1_1TeamsDB__inherit__graph.dot create mode 100644 apidocs/html/classtmadmin__manage_1_1TmAdminManage-members.html create mode 100644 apidocs/html/classtmadmin__manage_1_1TmAdminManage.html create mode 100644 apidocs/html/classtmadmin__manage_1_1TmAdminManage__coll__graph.dot create mode 100644 apidocs/html/classtmadmin__manage_1_1TmAdminManage__inherit__graph.dot create mode 100644 apidocs/html/classtmadmin__manage_1_1TmAdminManage_a07ce654c77614118620958b2bb8d8d5f_icgraph.dot create mode 100644 apidocs/html/classtmadmin__manage_1_1TmAdminManage_a73e2c378e714adf64beeb922a4431b28_icgraph.dot create mode 100644 apidocs/html/classtmadmin__manage_1_1TmAdminManage_ab48561726ee5abc6f0ad12c2c6e418cf_cgraph.dot create mode 100644 apidocs/html/classtmclient_1_1TMClient-members.html create mode 100644 apidocs/html/classtmclient_1_1TMClient.html create mode 100644 apidocs/html/classtmclient_1_1TMClient__coll__graph.dot create mode 100644 apidocs/html/classtmclient_1_1TMClient__inherit__graph.dot create mode 100644 apidocs/html/classtmclient_1_1TMClient_a2be43ead01d39949747251d84f796319_cgraph.dot create mode 100644 apidocs/html/classtmclient_1_1TMClient_a91c8cab892d16a8c7b961509e7304bd1_icgraph.dot create mode 100644 apidocs/html/classtmdb_1_1TMImport-members.html create mode 100644 apidocs/html/classtmdb_1_1TMImport.html create mode 100644 apidocs/html/classtmdb_1_1TMImport__coll__graph.dot create mode 100644 apidocs/html/classtmdb_1_1TMImport__inherit__graph.dot create mode 100644 apidocs/html/classtmdb_1_1TMImport_a26aed14fd58585480c971504a5fef5fc_icgraph.dot create mode 100644 apidocs/html/classtmdb_1_1TMImport_a6f8a3419014e5b6bdffecef12aaa79b2_icgraph.dot create mode 100644 apidocs/html/classtmdb_1_1TMImport_aea4f362d2d50f3b6d589875c21ca790e_cgraph.dot create mode 100644 apidocs/html/classtmserver_1_1RequestServicer-members.html create mode 100644 apidocs/html/classtmserver_1_1RequestServicer.html create mode 100644 apidocs/html/classtmserver_1_1RequestServicer__coll__graph.dot create mode 100644 apidocs/html/classtmserver_1_1RequestServicer__inherit__graph.dot create mode 100644 apidocs/html/classtmserver_1_1TMServer-members.html create mode 100644 apidocs/html/classtmserver_1_1TMServer.html create mode 100644 apidocs/html/classtmserver_1_1TMServer__coll__graph.dot create mode 100644 apidocs/html/classtmserver_1_1TMServer__inherit__graph.dot create mode 100644 apidocs/html/classtmserver_1_1TMServer_aa71d5ad0dab82d9af80c5e7a9a65d62c_icgraph.dot create mode 100644 apidocs/html/classtmserver_1_1TMServer_ad776ecdbd12903199f91c141f8a120c8_cgraph.dot create mode 100644 apidocs/html/classusers_1_1UsersDB-members.html create mode 100644 apidocs/html/classusers_1_1UsersDB.html create mode 100644 apidocs/html/classusers_1_1UsersDB__coll__graph.dot create mode 100644 apidocs/html/classusers_1_1UsersDB__inherit__graph.dot create mode 100644 apidocs/html/classusers_1_1UsersDB_a211a51d70fea3b4a3691a6ddc7e24b84_cgraph.dot create mode 100644 apidocs/html/classusers_1_1UsersDB_a48c38de764ffd4f0ef70c5b7c8f00574_cgraph.dot create mode 100644 apidocs/html/classusers_1_1UsersDB_a6255686dd986eae2f74bcef6dc99cdc0_icgraph.dot create mode 100644 apidocs/html/classusers_1_1UsersDB_a9d18dcb81055343c7f9175cde58b1ec8_cgraph.dot create mode 100644 apidocs/html/classusers_1_1UsersDB_ab39c1569a06030f772b69312d2c8f274_cgraph.dot create mode 100644 apidocs/html/classusers_1_1UsersDB_ac4e045ee980fc37a826cc3dd10c892ce_cgraph.dot create mode 100644 apidocs/html/classusers_1_1UsersDB_ace3dd5c5c9d13b55ec32a0da26a06f2c_icgraph.dot create mode 100644 apidocs/html/classyamlfile_1_1YamlFile-members.html create mode 100644 apidocs/html/classyamlfile_1_1YamlFile.html create mode 100644 apidocs/html/classyamlfile_1_1YamlFile__coll__graph.dot create mode 100644 apidocs/html/classyamlfile_1_1YamlFile__inherit__graph.dot create mode 100644 apidocs/html/closed.png create mode 100644 apidocs/html/conftest_8py_source.html create mode 100644 apidocs/html/dbsupport_8py_source.html create mode 100644 apidocs/html/dir_2751e589abeffcf20ff2eeb9e2122732.html create mode 100644 apidocs/html/dir_348505f96b956caabe4d74ae5673ffa6.html create mode 100644 apidocs/html/dir_59425e443f801f1f2fd8bbe4959a3ccf.html create mode 100644 apidocs/html/dir_6b7046e8fbf7bd9518c790550f41f091.html create mode 100644 apidocs/html/dir_6c545ee20ee14f97d8c93898dd491633.html create mode 100644 apidocs/html/dir_7aca4abf2cce35acb34fbbecc6101047.html create mode 100644 apidocs/html/dir_8b847e7567b96db9dee2188b16d3384b.html create mode 100644 apidocs/html/dir_fa7605c3f87aadbdcc71b9200f5eb483.html create mode 100644 apidocs/html/doc.png create mode 100644 apidocs/html/doxygen.css create mode 100644 apidocs/html/doxygen.svg create mode 100644 apidocs/html/dynsections.js create mode 100644 apidocs/html/files.html create mode 100644 apidocs/html/folderclosed.png create mode 100644 apidocs/html/folderopen.png create mode 100644 apidocs/html/functions.html create mode 100644 apidocs/html/functions_func.html create mode 100644 apidocs/html/generator_8py_source.html create mode 100644 apidocs/html/graph_legend.dot create mode 100644 apidocs/html/graph_legend.html create mode 100644 apidocs/html/hierarchy.html create mode 100644 apidocs/html/index.html create mode 100644 apidocs/html/inherit_graph_0.dot create mode 100644 apidocs/html/inherit_graph_1.dot create mode 100644 apidocs/html/inherit_graph_2.dot create mode 100644 apidocs/html/inherits.html create mode 100644 apidocs/html/jquery.js create mode 100644 apidocs/html/md__home_runner_work_tm_admin_tm_admin_tm_admin_CHANGELOG.html create mode 100644 apidocs/html/menu.js create mode 100644 apidocs/html/menudata.js create mode 100644 apidocs/html/namespaces.html create mode 100644 apidocs/html/namespacestrong.html create mode 100644 apidocs/html/namespacetests.html create mode 100644 apidocs/html/nav_f.png create mode 100644 apidocs/html/nav_g.png create mode 100644 apidocs/html/nav_h.png create mode 100644 apidocs/html/open.png create mode 100644 apidocs/html/organizations_8py_source.html create mode 100644 apidocs/html/pages.html create mode 100644 apidocs/html/projects_8py_source.html create mode 100644 apidocs/html/proto_8py_source.html create mode 100644 apidocs/html/search/all_0.html create mode 100644 apidocs/html/search/all_0.js create mode 100644 apidocs/html/search/all_1.html create mode 100644 apidocs/html/search/all_1.js create mode 100644 apidocs/html/search/all_2.html create mode 100644 apidocs/html/search/all_2.js create mode 100644 apidocs/html/search/all_3.html create mode 100644 apidocs/html/search/all_3.js create mode 100644 apidocs/html/search/all_4.html create mode 100644 apidocs/html/search/all_4.js create mode 100644 apidocs/html/search/all_5.html create mode 100644 apidocs/html/search/all_5.js create mode 100644 apidocs/html/search/all_6.html create mode 100644 apidocs/html/search/all_6.js create mode 100644 apidocs/html/search/all_7.html create mode 100644 apidocs/html/search/all_7.js create mode 100644 apidocs/html/search/all_8.html create mode 100644 apidocs/html/search/all_8.js create mode 100644 apidocs/html/search/all_9.html create mode 100644 apidocs/html/search/all_9.js create mode 100644 apidocs/html/search/all_a.html create mode 100644 apidocs/html/search/all_a.js create mode 100644 apidocs/html/search/all_b.html create mode 100644 apidocs/html/search/all_b.js create mode 100644 apidocs/html/search/all_c.html create mode 100644 apidocs/html/search/all_c.js create mode 100644 apidocs/html/search/all_d.html create mode 100644 apidocs/html/search/all_d.js create mode 100644 apidocs/html/search/all_e.html create mode 100644 apidocs/html/search/all_e.js create mode 100644 apidocs/html/search/classes_0.html create mode 100644 apidocs/html/search/classes_0.js create mode 100644 apidocs/html/search/classes_1.html create mode 100644 apidocs/html/search/classes_1.js create mode 100644 apidocs/html/search/classes_2.html create mode 100644 apidocs/html/search/classes_2.js create mode 100644 apidocs/html/search/classes_3.html create mode 100644 apidocs/html/search/classes_3.js create mode 100644 apidocs/html/search/classes_4.html create mode 100644 apidocs/html/search/classes_4.js create mode 100644 apidocs/html/search/classes_5.html create mode 100644 apidocs/html/search/classes_5.js create mode 100644 apidocs/html/search/classes_6.html create mode 100644 apidocs/html/search/classes_6.js create mode 100644 apidocs/html/search/classes_7.html create mode 100644 apidocs/html/search/classes_7.js create mode 100644 apidocs/html/search/classes_8.html create mode 100644 apidocs/html/search/classes_8.js create mode 100644 apidocs/html/search/close.svg create mode 100644 apidocs/html/search/functions_0.html create mode 100644 apidocs/html/search/functions_0.js create mode 100644 apidocs/html/search/functions_1.html create mode 100644 apidocs/html/search/functions_1.js create mode 100644 apidocs/html/search/functions_2.html create mode 100644 apidocs/html/search/functions_2.js create mode 100644 apidocs/html/search/functions_3.html create mode 100644 apidocs/html/search/functions_3.js create mode 100644 apidocs/html/search/functions_4.html create mode 100644 apidocs/html/search/functions_4.js create mode 100644 apidocs/html/search/functions_5.html create mode 100644 apidocs/html/search/functions_5.js create mode 100644 apidocs/html/search/functions_6.html create mode 100644 apidocs/html/search/functions_6.js create mode 100644 apidocs/html/search/functions_7.html create mode 100644 apidocs/html/search/functions_7.js create mode 100644 apidocs/html/search/functions_8.html create mode 100644 apidocs/html/search/functions_8.js create mode 100644 apidocs/html/search/functions_9.html create mode 100644 apidocs/html/search/functions_9.js create mode 100644 apidocs/html/search/functions_a.html create mode 100644 apidocs/html/search/functions_a.js create mode 100644 apidocs/html/search/mag_sel.svg create mode 100644 apidocs/html/search/namespaces_0.html create mode 100644 apidocs/html/search/namespaces_0.js create mode 100644 apidocs/html/search/namespaces_1.html create mode 100644 apidocs/html/search/namespaces_1.js create mode 100644 apidocs/html/search/nomatches.html create mode 100644 apidocs/html/search/pages_0.html create mode 100644 apidocs/html/search/pages_0.js create mode 100644 apidocs/html/search/search.css create mode 100644 apidocs/html/search/search.js create mode 100644 apidocs/html/search/search_l.png create mode 100644 apidocs/html/search/search_m.png create mode 100644 apidocs/html/search/search_r.png create mode 100644 apidocs/html/search/searchdata.js create mode 100644 apidocs/html/splitbar.png create mode 100644 apidocs/html/sync_off.png create mode 100644 apidocs/html/sync_on.png create mode 100644 apidocs/html/tab_a.png create mode 100644 apidocs/html/tab_b.png create mode 100644 apidocs/html/tab_h.png create mode 100644 apidocs/html/tab_s.png create mode 100644 apidocs/html/tabs.css create mode 100644 apidocs/html/tasks_8py_source.html create mode 100644 apidocs/html/teams_8py_source.html create mode 100644 apidocs/html/test__campaigns_8py_source.html create mode 100644 apidocs/html/test__dbsupport_8py_source.html create mode 100644 apidocs/html/test__messages_8py_source.html create mode 100644 apidocs/html/test__notifications_8py_source.html create mode 100644 apidocs/html/test__orgs_8py_source.html create mode 100644 apidocs/html/test__placeholder_8py_source.html create mode 100644 apidocs/html/test__projects_8py_source.html create mode 100644 apidocs/html/test__tasks_8py_source.html create mode 100644 apidocs/html/test__teams_8py_source.html create mode 100644 apidocs/html/test__users_8py_source.html create mode 100644 apidocs/html/test__validation_8py_source.html create mode 100644 apidocs/html/test__yamlfile_8py_source.html create mode 100644 apidocs/html/tmadmin__manage_8py_source.html create mode 100644 apidocs/html/tmclient_8py_source.html create mode 100644 apidocs/html/tmdb_8py_source.html create mode 100644 apidocs/html/tmserver_8py_source.html create mode 100644 apidocs/html/users_8py_source.html create mode 100644 apidocs/html/yamlfile_8py_source.html create mode 100644 assets/_mkdocstrings.css create mode 100644 assets/images/favicon.png create mode 100644 assets/javascripts/bundle.aecac24b.min.js create mode 100644 assets/javascripts/bundle.aecac24b.min.js.map create mode 100644 assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 assets/javascripts/lunr/min/lunr.el.min.js create mode 100644 assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.he.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hy.min.js create mode 100644 assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 assets/javascripts/lunr/min/lunr.kn.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sa.min.js create mode 100644 assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 assets/javascripts/lunr/min/lunr.te.min.js create mode 100644 assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 assets/javascripts/lunr/tinyseg.js create mode 100644 assets/javascripts/lunr/wordcut.js create mode 100644 assets/javascripts/workers/search.f886a092.min.js create mode 100644 assets/javascripts/workers/search.f886a092.min.js.map create mode 100644 assets/stylesheets/main.35e1ed30.min.css create mode 100644 assets/stylesheets/main.35e1ed30.min.css.map create mode 100644 assets/stylesheets/palette.356b1318.min.css create mode 100644 assets/stylesheets/palette.356b1318.min.css.map create mode 100644 build/index.html create mode 100644 communication/index.html create mode 100644 configuring/index.html create mode 100644 css/extra.css create mode 100644 dataexchange/index.html create mode 100644 dataflow/index.html create mode 100644 endpoints/index.html create mode 100644 generator/index.html create mode 100644 getting_started/index.html create mode 100644 images/favicon.png create mode 100644 images/hot_logo.png create mode 100644 importing/index.html create mode 100644 index.html create mode 100644 objects.inv create mode 100644 protos-api/index.html create mode 100644 schema/index.html create mode 100644 search/search_index.json create mode 100644 sitemap.xml create mode 100644 sitemap.xml.gz create mode 100644 tmadmin-manage/index.html create mode 100644 tmdb/index.html create mode 100644 tmschema/index.html create mode 100644 wiki_redirect/index.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..595f53c5 --- /dev/null +++ b/404.html @@ -0,0 +1,859 @@ + + + + + + + + + + + + + + + + + + + + + tm-admin + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/CHANGELOG/index.html b/CHANGELOG/index.html new file mode 100644 index 00000000..64a5c3a5 --- /dev/null +++ b/CHANGELOG/index.html @@ -0,0 +1,1266 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Changelog - tm-admin + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+ + + + + + + +

Changelog

+ +

Unreleased

+

Fix

+
    +
  • refactor importing invalidation history
  • +
  • Don't create the database by default, it's now an option
  • +
  • Add comment about int vs int array
  • +
  • Add some block comments for mkdocs
  • +
  • Refactor to update the array of nested tables for history
  • +
  • Drop outline, it's a duplicate of geometry, which is what TM uses
  • +
  • fix: Add the id and project_id so they're in the SQL query
  • +
  • Add the id and project_id so they're in the SQL query
  • +
  • Process WKB for points correctly
  • +
  • be less verbose
  • +
  • Uses Geometry() instead of point or polygon
  • +
  • Improve performance of importing data by using pages
  • +
  • Add threaded paging support for task_history table
  • +
  • Refactor to import large datasets in pages and threading
  • +
  • generate pngs for Markdown and PDFs from the .odt drawings
  • +
  • Don't store pngs, they can be automatically generated
  • +
  • Add threaded progress bars, paginate large postgres tables
  • +
  • Add campaigns table, import the utility tables into this table
  • +
  • Add messages config file
  • +
  • Drop duplicate columns as this table is now nested in the tasks table
  • +
  • Add task history and invalidation history as nested tables
  • +
  • Implement a few tests for a sanity check
  • +
  • Generate more test data for messages and campaigns
  • +
  • Update after role enum changes
  • +
  • pg.execute doesn't return anything
  • +
  • Start implementing commands, now all generated SQL tables can get loaded into the database
  • +
  • Minor tweaks to keep yamlint happy
  • +
  • Make importing the primary table multi-threaded to improve performance
  • +
  • Fix typo in type
  • +
  • Make id a unique sequence variable
  • +
  • Add array for managers
  • +
  • Move team_members to it's own file
  • +
  • Add enums for message types
  • +
  • Add nested table definition
  • +
  • Updated with more data
  • +
  • Make importing data multi-threaded, it still takes a long time
  • +
  • Add section on testing
  • +
  • Add env variable for test database
  • +
  • Add env variable to change the test database
  • +
  • Add more API test case stubs
  • +
  • Add more detail to reduce the pain of a new developer
  • +
  • Add more content, update the intro section
  • +
  • Add doc on the TM database schema as it exists now
  • +
  • Add config file for campaigns
  • +
  • Create team_members table for the users table
  • +
  • Add support json as a data type, and nested tables
  • +
  • Add tests for the featured column
  • +
  • Implement methods for favorite projects
  • +
  • Add method to remove an element from an array
  • +
  • Add more project tests
  • +
  • Add content on projects table
  • +
  • Add more task related config files
  • +
  • Add project_chat table
  • +
  • Start on adding Task History support
  • +
  • Add support for getting a single column, or updating an array
  • +
  • Add target dump licenses and interests tables
  • +
  • Add more test cases
  • +
  • Add more tests
  • +
  • Add 3 more columns from other tables
  • +
  • Add support to merge the TM project_info data into the TM Admin projects table
  • +
  • Add columns from the TM project_info table
  • +
  • Make merging from user_licenses multi-threaded
  • +
  • New config file for task_history table
  • +
  • Regenerated after populating interests, licenses, and favorites with data from TM
  • +
  • Import into testdata DB, not tm_admin
  • +
  • Add more info on the user tables
  • +
  • Add support to import from the TM4 user_licenses table into the licenses array in the tm_admin table
  • +
  • Add support to merge the TM user_interests table into the tm_admin users table as an array
  • +
  • Update tests after dbsupport changes
  • +
  • Use row_to_json() in all queries
  • +
  • Add target to import all .sql files into the test database
  • +
  • Use testdata generated from postgres
  • +
  • Handle required database columns not in the input source
  • +
  • Move target to build test data files to tests from top level
  • +
  • Add teams API tests
  • +
  • Add more tests, add unimplemented debug to stubs
  • +
  • Add stubs for all the TM internal APIs
  • +
  • Add more tests from the TM backend
  • +
  • Add data for test cases
  • +
  • Comment out mapper_level for now
  • +
  • Add join_method
  • +
  • Fix logging
  • +
  • Add more generated files
  • +
  • Minor cleanup, no code changes
  • +
  • Add check target to run pytests
  • +
  • Get Entries here
  • +
  • Add one more endpoint to the doc
  • +
  • Don't get Entries in the constructor
  • +
  • Minor changes to keep yamllint happy
  • +
  • be less verbose
  • +
  • If required, use '' instead of NULL
  • +
  • Escape strings to remove embedded single quotes
  • +
  • Handle zero length arrays
  • +
  • Refactor creating the INSERT command, use the config file for datatypes
  • +
  • Ad dminimal testcase for YAML config file parsing
  • +
  • Refactor the YAML into a dict, instead of a list of lists
  • +
  • Keep yamllint happy, adjust indents
  • +
  • Import the TM projects table is starting to work, whew
  • +
  • Add test case for organizations table
  • +
  • Don't import UsersMessage
  • +
  • Make userDB global to keep pytest happy
  • +
  • Add more comments
  • +
  • Add delete by ID
  • +
  • Recursively scan for source files
  • +
  • Add endpoints doc
  • +
  • Add more API docs for the table classes
  • +
  • Add more endpoints from TM admin
  • +
  • Add wrappers for common SQL queries to the user table
  • +
  • New test case for User table endpoint support
  • +
  • Add column to tables for if supported by TM Admin
  • +
  • Add draft of a doc on comparing endpoints between TM and FMTM
  • +
  • Add comment about bugs in config file
  • +
  • Add subscription_tier
  • +
  • Import TM organisations table into TM Admin database
  • +
  • for SQL, int64 generates a bigint
  • +
  • Add a target to generate test date from TM
  • +
  • New module for importing data from a Tasking Manager database into a TM Admin database
  • +
  • Add more columns used by TM
  • +
  • Convert int64 to bigint for SQL
  • +
  • Some ID fileds are strings, not integers
  • +
  • Add endpoints to receive data of profiles
  • +
  • Make VALIDATOR unique
  • +
  • Add methode to find a project or task by location
  • +
  • Fix type in comment block
  • +
  • fix module name
  • +
  • Add more content in dataexchange page, add to index page
  • +
  • Initial draft of a deep dive into exchaning data between multiple projects
  • +
  • Minor typo repair
  • +
  • Add dbsupport to API docs
  • +
  • Add apidocs produced by doxygen
  • +
  • Add protobuf API doc
  • +
  • Use Markdown output instead of HTML so it works better with Github Pages
  • +
  • Add doxygen support
  • +
  • For docs target, also make the protobuf api docs
  • +
  • Add links to tech deep dives
  • +
  • Remove stupid comment
  • +
  • Add more mkdocs comments
  • +
  • Add more mkdocs comments
  • +
  • Change the name of the output file for protobuf files
  • +
  • Add mkdocs_protobuf plugin
  • +
  • Use protoc-gen-docs to generate documentation for all the protobuf files
  • +
  • Add mkdocs comment block
  • +
  • Add mkdocs block comments
  • +
  • aAdd more request types
  • +
  • WHen converting Point or Polygon, it needs to stay upper case
  • +
  • Comment out the other endpoints but request and notifications
  • +
  • Use DBSupport as a base class
  • +
  • Minor refactoring to support testing
  • +
  • Refactor table classes to use a shared base class
  • +
  • Update versions
  • +
  • Updatw versions to the current one
  • +
  • Comment out for now unimplemented optioms
  • +
  • Improve logging setup
  • +
  • Use new dbsupport class to avoid code duplication
  • +
  • Use DBSupport for all methods
  • +
  • Use lowercsase
  • +
  • Use new dbsupport class to avoid code duplication
  • +
  • Improve how logging works
  • +
  • Add email to test case
  • +
  • Use polygon or point instaed of public.geometry
  • +
  • Use polygon or point instead of the whole public.geometry line
  • +
  • Support for organizations tanble
  • +
  • Add error for unimplemented requests
  • +
  • Add more fields to the request and response messages
  • +
  • Return single entry in list for query by ID or name to be comsistent
  • +
  • Process request for user profile
  • +
  • convert response to dict
  • +
  • Include dict in protobuf response
  • +
  • Use IntEnum instead of just Enum
  • +
  • Only have one namespace, since it has to be shared between server and client
  • +
  • Delete reuests.proto
  • +
  • he type file has a _tm appended
  • +
  • Build protobuf docs
  • +
  • Add request and notification enums
  • +
  • gRPC prefers a single top lecel service
  • +
  • Exhchange messages
  • +
  • Start workong with new data structures
  • +
  • COnvert geometry to bytes
  • +
  • Don't use package
  • +
  • Add more generated files
  • +
  • Close the file after writing it
  • +
  • Add stubs for requests and datga exchange
  • +
  • Add comments about modified enums used by TM, which was needed to avoid duplication
  • +
  • For protobuf, all enum values must be unique globally
  • +
  • Be less verbose
  • +
  • Add more enum from TM statues file
  • +
  • handle protobuf enums better
  • +
  • Handle public enums better for protobuf files
  • +
  • FIx indenting problems
  • +
  • Add Mappinglevel enum that somehow got missed
  • +
  • These don't work fully yet, just for development
  • +
  • Start adding endpoints
  • +
  • Drop the index page
  • +
  • Fix a few typos
  • +
  • Update CHANGELOG
  • +
  • Fix typo in password settings
  • +
  • Oops, add colon to tag
  • +
  • Add more columns from TM
  • +
  • Add section on the new unique keyword
  • +
  • Add more content
  • +
  • Add doc on the data flow, since there are a lot of generated files used elsewhere
  • +
  • Add support for updating records, including the enums
  • +
  • Add a unique contraint
  • +
  • Add method to reset the sequence for id
  • +
  • Query by ID name, or all rows, which is what TM needs
  • +
  • update CHANGELOG
  • +
  • Support class for managing the users table
  • +
  • Make more items be shared in messages
  • +
  • Handle datetime now
  • +
  • Nre proto file for message requests
  • +
  • Now generated classes use named parameters, which also get store in a dict
  • +
  • Delete the new generated files
  • +
  • Also generate the python stubs for data structures
  • +
  • Create the tables in the database from the generated SQL files
  • +
  • Update CHANGELOG
  • +
  • Add actual content
  • +
  • Add new files to API docs
  • +
  • Major refactoring to use YAML config file for all file generation
  • +
  • Major refactoring to use YAML config file for .sql generation
  • +
  • Major refactoring to use YAML config file for .proto generation
  • +
  • Add generated files to reduce clutter
  • +
  • Refactoring to use yaml files for file generation completed
  • +
  • Add organization section
  • +
  • Add doc on the communication details
  • +
  • Add initial content for a doc on data flow between projects
  • +
  • Add default page
  • +
  • Add doc on this project
  • +
  • Add recursive targets, since tm_admin/Makefile does all the work
  • +
  • Set version number to 0.1.0
  • +
  • Start refactoring to use our messages
  • +
  • Generate the SQL files from the YAML files
  • +
  • add one sentence about python
  • +
  • The SQL files now get generated from the YAML config files
  • +
  • Drop SQL files, they're now generated from the yaml config files
  • +
  • Add config file for organizxations table
  • +
  • Add config file for tasks table
  • +
  • Add config file for projects table
  • +
  • Always generate types_tm.* files, improve handling of sequences
  • +
  • Generate all the types_tm files
  • +
  • Add config file for all typedefs and the user table
  • +
  • Remove the generated type_tm.* files too
  • +
  • Add new file documenting the yaml based config file syntax
  • +
  • Generate SQL from yaml file
  • +
  • Generate SQL and protobuf files from yaml config file
  • +
  • Add method to convert a .proto file to a python dict
  • +
  • update services to support user profiles
  • +
  • Minimal implementation sending user profile data between client & server
  • +
  • Don't display the comments in the target
  • +
  • Add config file and use it to specify host:port for the other programs
  • +
  • Build the top level services stubs
  • +
  • add grpc dependencies
  • +
  • Improve table creation
  • +
  • Update AGPL code block
  • +
  • Move protobuf creation code to it's own file and use it
  • +
  • Add realclean target to get rid of all non source files
  • +
  • Use the protoc in grpc, not protobuf
  • +
  • Add dependencies
  • +
  • Add changelog file
  • +
  • Add target to run Doxygen
  • +
  • More files to create documentation infrastructure
  • +
  • Add Doxyfile to generate API docs
  • +
  • Update the License file
  • +
  • Add more files
  • +
  • Add the generated types* files too
  • +
  • Add default docs
  • +
  • Install the module
  • +
  • sloppy merge for new code into a real git repo
  • +
+

Refactor

+
    +
  • rename tmadmin-manage --> tmadmin_manage
  • +
+ +
+
+ + + Last update: + February 19, 2024 + + + +
+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 00000000..d501d651 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2811 @@ +# Doxyfile 1.9.7 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = TM-Admin + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Backend support for Tasking Manager style projects" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = apidocs + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN Use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0. and GITHUB Use the lower case version of title +# with any whitespace replaced by '-' and punctations characters removed.. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = SYSTEM + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ../tm_admin ../tests + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = index.md + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS +# tag is set to YES then doxygen will add the directory of each input to the +# include path. +# The default value is: YES. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /