bump: doxygen 1.13.2 -> 1.14.0
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index e52ccc5..28fcb09 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -7,7 +7,7 @@
branches: [main]
env:
- DEFAULT_DOXYGEN_VERSION: "1.13.2"
+ DEFAULT_DOXYGEN_VERSION: "1.14.0"
jobs:
tests:
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 440f254..f69c3e9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,12 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [2.4.0]
+
+### Changed
+
+- Default doxygen version is now `1.14.0`
+
## [2.3.0]
### Added
@@ -167,4 +173,5 @@
[2.2.1]: https://github.com/TendTo/rules_doxygen/compare/2.2.0...2.2.1
[2.2.2]: https://github.com/TendTo/rules_doxygen/compare/2.2.1...2.2.2
[2.3.0]: https://github.com/TendTo/rules_doxygen/compare/2.2.2...2.3.0
-[NEXT.VERSION]: https://github.com/TendTo/rules_doxygen/compare/2.3.0...HEAD
+[2.4.0]: https://github.com/TendTo/rules_doxygen/compare/2.3.0...2.4.0
+[NEXT.VERSION]: https://github.com/TendTo/rules_doxygen/compare/2.4.0...HEAD
diff --git a/README.md b/README.md
index c8b4113..7f9877e 100644
--- a/README.md
+++ b/README.md
@@ -44,7 +44,7 @@
use_repo(doxygen_extension, "doxygen")
```
-The extension will create a default configuration for all platforms with the version `1.13.2` of Doxygen.
+The extension will create a default configuration for all platforms with the version `1.14.0` of Doxygen.
You can override this value with a custom one for each supported platform, i.e. _windows_, _mac_, _mac-arm_, _linux_ and _linux-arm_.
```bzl
diff --git a/docs/doxygen_doc.md b/docs/doxygen_doc.md
index 694f8f7..cf741f5 100755
--- a/docs/doxygen_doc.md
+++ b/docs/doxygen_doc.md
@@ -68,31 +68,31 @@
<a href="#doxygen-generate_htmlhelp">generate_htmlhelp</a>, <a href="#doxygen-chm_file">chm_file</a>, <a href="#doxygen-hhc_location">hhc_location</a>, <a href="#doxygen-generate_chi">generate_chi</a>, <a href="#doxygen-chm_index_encoding">chm_index_encoding</a>, <a href="#doxygen-binary_toc">binary_toc</a>,
<a href="#doxygen-toc_expand">toc_expand</a>, <a href="#doxygen-sitemap_url">sitemap_url</a>, <a href="#doxygen-generate_qhp">generate_qhp</a>, <a href="#doxygen-qch_file">qch_file</a>, <a href="#doxygen-qhp_namespace">qhp_namespace</a>, <a href="#doxygen-qhp_virtual_folder">qhp_virtual_folder</a>,
<a href="#doxygen-qhp_cust_filter_name">qhp_cust_filter_name</a>, <a href="#doxygen-qhp_cust_filter_attrs">qhp_cust_filter_attrs</a>, <a href="#doxygen-qhp_sect_filter_attrs">qhp_sect_filter_attrs</a>, <a href="#doxygen-qhg_location">qhg_location</a>,
- <a href="#doxygen-generate_eclipsehelp">generate_eclipsehelp</a>, <a href="#doxygen-eclipse_doc_id">eclipse_doc_id</a>, <a href="#doxygen-disable_index">disable_index</a>, <a href="#doxygen-generate_treeview">generate_treeview</a>, <a href="#doxygen-full_sidebar">full_sidebar</a>,
- <a href="#doxygen-enum_values_per_line">enum_values_per_line</a>, <a href="#doxygen-show_enum_values">show_enum_values</a>, <a href="#doxygen-treeview_width">treeview_width</a>, <a href="#doxygen-ext_links_in_window">ext_links_in_window</a>, <a href="#doxygen-obfuscate_emails">obfuscate_emails</a>,
- <a href="#doxygen-html_formula_format">html_formula_format</a>, <a href="#doxygen-formula_fontsize">formula_fontsize</a>, <a href="#doxygen-formula_macrofile">formula_macrofile</a>, <a href="#doxygen-use_mathjax">use_mathjax</a>, <a href="#doxygen-mathjax_version">mathjax_version</a>,
- <a href="#doxygen-mathjax_format">mathjax_format</a>, <a href="#doxygen-mathjax_relpath">mathjax_relpath</a>, <a href="#doxygen-mathjax_extensions">mathjax_extensions</a>, <a href="#doxygen-mathjax_codefile">mathjax_codefile</a>, <a href="#doxygen-searchengine">searchengine</a>,
- <a href="#doxygen-server_based_search">server_based_search</a>, <a href="#doxygen-external_search">external_search</a>, <a href="#doxygen-searchengine_url">searchengine_url</a>, <a href="#doxygen-searchdata_file">searchdata_file</a>, <a href="#doxygen-external_search_id">external_search_id</a>,
- <a href="#doxygen-extra_search_mappings">extra_search_mappings</a>, <a href="#doxygen-generate_latex">generate_latex</a>, <a href="#doxygen-latex_output">latex_output</a>, <a href="#doxygen-latex_cmd_name">latex_cmd_name</a>, <a href="#doxygen-makeindex_cmd_name">makeindex_cmd_name</a>,
- <a href="#doxygen-latex_makeindex_cmd">latex_makeindex_cmd</a>, <a href="#doxygen-compact_latex">compact_latex</a>, <a href="#doxygen-paper_type">paper_type</a>, <a href="#doxygen-extra_packages">extra_packages</a>, <a href="#doxygen-latex_header">latex_header</a>, <a href="#doxygen-latex_footer">latex_footer</a>,
- <a href="#doxygen-latex_extra_stylesheet">latex_extra_stylesheet</a>, <a href="#doxygen-latex_extra_files">latex_extra_files</a>, <a href="#doxygen-pdf_hyperlinks">pdf_hyperlinks</a>, <a href="#doxygen-use_pdflatex">use_pdflatex</a>, <a href="#doxygen-latex_batchmode">latex_batchmode</a>,
- <a href="#doxygen-latex_hide_indices">latex_hide_indices</a>, <a href="#doxygen-latex_bib_style">latex_bib_style</a>, <a href="#doxygen-latex_emoji_directory">latex_emoji_directory</a>, <a href="#doxygen-generate_rtf">generate_rtf</a>, <a href="#doxygen-rtf_output">rtf_output</a>,
- <a href="#doxygen-compact_rtf">compact_rtf</a>, <a href="#doxygen-rtf_hyperlinks">rtf_hyperlinks</a>, <a href="#doxygen-rtf_stylesheet_file">rtf_stylesheet_file</a>, <a href="#doxygen-rtf_extensions_file">rtf_extensions_file</a>, <a href="#doxygen-rtf_extra_files">rtf_extra_files</a>,
- <a href="#doxygen-generate_man">generate_man</a>, <a href="#doxygen-man_output">man_output</a>, <a href="#doxygen-man_extension">man_extension</a>, <a href="#doxygen-man_subdir">man_subdir</a>, <a href="#doxygen-man_links">man_links</a>, <a href="#doxygen-generate_xml">generate_xml</a>, <a href="#doxygen-xml_output">xml_output</a>,
- <a href="#doxygen-xml_programlisting">xml_programlisting</a>, <a href="#doxygen-xml_ns_memb_file_scope">xml_ns_memb_file_scope</a>, <a href="#doxygen-generate_docbook">generate_docbook</a>, <a href="#doxygen-docbook_output">docbook_output</a>,
- <a href="#doxygen-generate_autogen_def">generate_autogen_def</a>, <a href="#doxygen-generate_sqlite3">generate_sqlite3</a>, <a href="#doxygen-sqlite3_output">sqlite3_output</a>, <a href="#doxygen-sqlite3_recreate_db">sqlite3_recreate_db</a>, <a href="#doxygen-generate_perlmod">generate_perlmod</a>,
- <a href="#doxygen-perlmod_latex">perlmod_latex</a>, <a href="#doxygen-perlmod_pretty">perlmod_pretty</a>, <a href="#doxygen-perlmod_makevar_prefix">perlmod_makevar_prefix</a>, <a href="#doxygen-enable_preprocessing">enable_preprocessing</a>, <a href="#doxygen-macro_expansion">macro_expansion</a>,
- <a href="#doxygen-expand_only_predef">expand_only_predef</a>, <a href="#doxygen-search_includes">search_includes</a>, <a href="#doxygen-include_path">include_path</a>, <a href="#doxygen-include_file_patterns">include_file_patterns</a>, <a href="#doxygen-predefined">predefined</a>,
- <a href="#doxygen-expand_as_defined">expand_as_defined</a>, <a href="#doxygen-skip_function_macros">skip_function_macros</a>, <a href="#doxygen-tagfiles">tagfiles</a>, <a href="#doxygen-generate_tagfile">generate_tagfile</a>, <a href="#doxygen-allexternals">allexternals</a>,
- <a href="#doxygen-external_groups">external_groups</a>, <a href="#doxygen-external_pages">external_pages</a>, <a href="#doxygen-hide_undoc_relations">hide_undoc_relations</a>, <a href="#doxygen-have_dot">have_dot</a>, <a href="#doxygen-dot_num_threads">dot_num_threads</a>,
- <a href="#doxygen-dot_common_attr">dot_common_attr</a>, <a href="#doxygen-dot_edge_attr">dot_edge_attr</a>, <a href="#doxygen-dot_node_attr">dot_node_attr</a>, <a href="#doxygen-dot_fontpath">dot_fontpath</a>, <a href="#doxygen-dot_transparent">dot_transparent</a>, <a href="#doxygen-class_graph">class_graph</a>,
- <a href="#doxygen-collaboration_graph">collaboration_graph</a>, <a href="#doxygen-group_graphs">group_graphs</a>, <a href="#doxygen-uml_look">uml_look</a>, <a href="#doxygen-uml_limit_num_fields">uml_limit_num_fields</a>, <a href="#doxygen-dot_uml_details">dot_uml_details</a>,
- <a href="#doxygen-dot_wrap_threshold">dot_wrap_threshold</a>, <a href="#doxygen-template_relations">template_relations</a>, <a href="#doxygen-include_graph">include_graph</a>, <a href="#doxygen-included_by_graph">included_by_graph</a>, <a href="#doxygen-call_graph">call_graph</a>,
- <a href="#doxygen-caller_graph">caller_graph</a>, <a href="#doxygen-graphical_hierarchy">graphical_hierarchy</a>, <a href="#doxygen-directory_graph">directory_graph</a>, <a href="#doxygen-dir_graph_max_depth">dir_graph_max_depth</a>, <a href="#doxygen-dot_image_format">dot_image_format</a>,
- <a href="#doxygen-interactive_svg">interactive_svg</a>, <a href="#doxygen-dot_path">dot_path</a>, <a href="#doxygen-dotfile_dirs">dotfile_dirs</a>, <a href="#doxygen-dia_path">dia_path</a>, <a href="#doxygen-diafile_dirs">diafile_dirs</a>, <a href="#doxygen-plantuml_jar_path">plantuml_jar_path</a>,
- <a href="#doxygen-plantuml_cfg_file">plantuml_cfg_file</a>, <a href="#doxygen-plantuml_include_path">plantuml_include_path</a>, <a href="#doxygen-plantumlfile_dirs">plantumlfile_dirs</a>, <a href="#doxygen-dot_graph_max_nodes">dot_graph_max_nodes</a>,
- <a href="#doxygen-max_dot_graph_depth">max_dot_graph_depth</a>, <a href="#doxygen-dot_multi_targets">dot_multi_targets</a>, <a href="#doxygen-generate_legend">generate_legend</a>, <a href="#doxygen-dot_cleanup">dot_cleanup</a>, <a href="#doxygen-mscgen_tool">mscgen_tool</a>,
- <a href="#doxygen-mscfile_dirs">mscfile_dirs</a>, <a href="#doxygen-kwargs">**kwargs</a>)
+ <a href="#doxygen-generate_eclipsehelp">generate_eclipsehelp</a>, <a href="#doxygen-eclipse_doc_id">eclipse_doc_id</a>, <a href="#doxygen-disable_index">disable_index</a>, <a href="#doxygen-generate_treeview">generate_treeview</a>, <a href="#doxygen-page_outline_panel">page_outline_panel</a>,
+ <a href="#doxygen-full_sidebar">full_sidebar</a>, <a href="#doxygen-enum_values_per_line">enum_values_per_line</a>, <a href="#doxygen-show_enum_values">show_enum_values</a>, <a href="#doxygen-treeview_width">treeview_width</a>, <a href="#doxygen-ext_links_in_window">ext_links_in_window</a>,
+ <a href="#doxygen-obfuscate_emails">obfuscate_emails</a>, <a href="#doxygen-html_formula_format">html_formula_format</a>, <a href="#doxygen-formula_fontsize">formula_fontsize</a>, <a href="#doxygen-formula_macrofile">formula_macrofile</a>, <a href="#doxygen-use_mathjax">use_mathjax</a>,
+ <a href="#doxygen-mathjax_version">mathjax_version</a>, <a href="#doxygen-mathjax_format">mathjax_format</a>, <a href="#doxygen-mathjax_relpath">mathjax_relpath</a>, <a href="#doxygen-mathjax_extensions">mathjax_extensions</a>, <a href="#doxygen-mathjax_codefile">mathjax_codefile</a>,
+ <a href="#doxygen-searchengine">searchengine</a>, <a href="#doxygen-server_based_search">server_based_search</a>, <a href="#doxygen-external_search">external_search</a>, <a href="#doxygen-searchengine_url">searchengine_url</a>, <a href="#doxygen-searchdata_file">searchdata_file</a>,
+ <a href="#doxygen-external_search_id">external_search_id</a>, <a href="#doxygen-extra_search_mappings">extra_search_mappings</a>, <a href="#doxygen-generate_latex">generate_latex</a>, <a href="#doxygen-latex_output">latex_output</a>, <a href="#doxygen-latex_cmd_name">latex_cmd_name</a>,
+ <a href="#doxygen-makeindex_cmd_name">makeindex_cmd_name</a>, <a href="#doxygen-latex_makeindex_cmd">latex_makeindex_cmd</a>, <a href="#doxygen-compact_latex">compact_latex</a>, <a href="#doxygen-paper_type">paper_type</a>, <a href="#doxygen-extra_packages">extra_packages</a>,
+ <a href="#doxygen-latex_header">latex_header</a>, <a href="#doxygen-latex_footer">latex_footer</a>, <a href="#doxygen-latex_extra_stylesheet">latex_extra_stylesheet</a>, <a href="#doxygen-latex_extra_files">latex_extra_files</a>, <a href="#doxygen-pdf_hyperlinks">pdf_hyperlinks</a>,
+ <a href="#doxygen-use_pdflatex">use_pdflatex</a>, <a href="#doxygen-latex_batchmode">latex_batchmode</a>, <a href="#doxygen-latex_hide_indices">latex_hide_indices</a>, <a href="#doxygen-latex_bib_style">latex_bib_style</a>, <a href="#doxygen-latex_emoji_directory">latex_emoji_directory</a>,
+ <a href="#doxygen-generate_rtf">generate_rtf</a>, <a href="#doxygen-rtf_output">rtf_output</a>, <a href="#doxygen-compact_rtf">compact_rtf</a>, <a href="#doxygen-rtf_hyperlinks">rtf_hyperlinks</a>, <a href="#doxygen-rtf_stylesheet_file">rtf_stylesheet_file</a>,
+ <a href="#doxygen-rtf_extensions_file">rtf_extensions_file</a>, <a href="#doxygen-rtf_extra_files">rtf_extra_files</a>, <a href="#doxygen-generate_man">generate_man</a>, <a href="#doxygen-man_output">man_output</a>, <a href="#doxygen-man_extension">man_extension</a>, <a href="#doxygen-man_subdir">man_subdir</a>,
+ <a href="#doxygen-man_links">man_links</a>, <a href="#doxygen-generate_xml">generate_xml</a>, <a href="#doxygen-xml_output">xml_output</a>, <a href="#doxygen-xml_programlisting">xml_programlisting</a>, <a href="#doxygen-xml_ns_memb_file_scope">xml_ns_memb_file_scope</a>,
+ <a href="#doxygen-generate_docbook">generate_docbook</a>, <a href="#doxygen-docbook_output">docbook_output</a>, <a href="#doxygen-generate_autogen_def">generate_autogen_def</a>, <a href="#doxygen-generate_sqlite3">generate_sqlite3</a>, <a href="#doxygen-sqlite3_output">sqlite3_output</a>,
+ <a href="#doxygen-sqlite3_recreate_db">sqlite3_recreate_db</a>, <a href="#doxygen-generate_perlmod">generate_perlmod</a>, <a href="#doxygen-perlmod_latex">perlmod_latex</a>, <a href="#doxygen-perlmod_pretty">perlmod_pretty</a>, <a href="#doxygen-perlmod_makevar_prefix">perlmod_makevar_prefix</a>,
+ <a href="#doxygen-enable_preprocessing">enable_preprocessing</a>, <a href="#doxygen-macro_expansion">macro_expansion</a>, <a href="#doxygen-expand_only_predef">expand_only_predef</a>, <a href="#doxygen-search_includes">search_includes</a>, <a href="#doxygen-include_path">include_path</a>,
+ <a href="#doxygen-include_file_patterns">include_file_patterns</a>, <a href="#doxygen-predefined">predefined</a>, <a href="#doxygen-expand_as_defined">expand_as_defined</a>, <a href="#doxygen-skip_function_macros">skip_function_macros</a>, <a href="#doxygen-tagfiles">tagfiles</a>,
+ <a href="#doxygen-generate_tagfile">generate_tagfile</a>, <a href="#doxygen-allexternals">allexternals</a>, <a href="#doxygen-external_groups">external_groups</a>, <a href="#doxygen-external_pages">external_pages</a>, <a href="#doxygen-hide_undoc_relations">hide_undoc_relations</a>,
+ <a href="#doxygen-have_dot">have_dot</a>, <a href="#doxygen-dot_num_threads">dot_num_threads</a>, <a href="#doxygen-dot_common_attr">dot_common_attr</a>, <a href="#doxygen-dot_edge_attr">dot_edge_attr</a>, <a href="#doxygen-dot_node_attr">dot_node_attr</a>, <a href="#doxygen-dot_fontpath">dot_fontpath</a>,
+ <a href="#doxygen-dot_transparent">dot_transparent</a>, <a href="#doxygen-class_graph">class_graph</a>, <a href="#doxygen-collaboration_graph">collaboration_graph</a>, <a href="#doxygen-group_graphs">group_graphs</a>, <a href="#doxygen-uml_look">uml_look</a>,
+ <a href="#doxygen-uml_limit_num_fields">uml_limit_num_fields</a>, <a href="#doxygen-uml_max_edge_labels">uml_max_edge_labels</a>, <a href="#doxygen-dot_uml_details">dot_uml_details</a>, <a href="#doxygen-dot_wrap_threshold">dot_wrap_threshold</a>,
+ <a href="#doxygen-template_relations">template_relations</a>, <a href="#doxygen-include_graph">include_graph</a>, <a href="#doxygen-included_by_graph">included_by_graph</a>, <a href="#doxygen-call_graph">call_graph</a>, <a href="#doxygen-caller_graph">caller_graph</a>,
+ <a href="#doxygen-graphical_hierarchy">graphical_hierarchy</a>, <a href="#doxygen-directory_graph">directory_graph</a>, <a href="#doxygen-dir_graph_max_depth">dir_graph_max_depth</a>, <a href="#doxygen-dot_image_format">dot_image_format</a>, <a href="#doxygen-interactive_svg">interactive_svg</a>,
+ <a href="#doxygen-dot_path">dot_path</a>, <a href="#doxygen-dotfile_dirs">dotfile_dirs</a>, <a href="#doxygen-dia_path">dia_path</a>, <a href="#doxygen-diafile_dirs">diafile_dirs</a>, <a href="#doxygen-plantuml_jar_path">plantuml_jar_path</a>, <a href="#doxygen-plantuml_cfg_file">plantuml_cfg_file</a>,
+ <a href="#doxygen-plantuml_include_path">plantuml_include_path</a>, <a href="#doxygen-plantumlfile_dirs">plantumlfile_dirs</a>, <a href="#doxygen-dot_graph_max_nodes">dot_graph_max_nodes</a>, <a href="#doxygen-max_dot_graph_depth">max_dot_graph_depth</a>,
+ <a href="#doxygen-dot_multi_targets">dot_multi_targets</a>, <a href="#doxygen-generate_legend">generate_legend</a>, <a href="#doxygen-dot_cleanup">dot_cleanup</a>, <a href="#doxygen-mscgen_tool">mscgen_tool</a>, <a href="#doxygen-mscfile_dirs">mscfile_dirs</a>, <a href="#doxygen-kwargs">**kwargs</a>)
</pre>
Generates documentation using Doxygen.
@@ -415,7 +415,8 @@
| <a id="doxygen-eclipse_doc_id"></a>eclipse_doc_id | A unique identifier for the Eclipse help plugin. | `None` |
| <a id="doxygen-disable_index"></a>disable_index | 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. | `None` |
| <a id="doxygen-generate_treeview"></a>generate_treeview | The `generate_treeview` tag is used to specify whether a tree-like index structure should be generated to display hierarchical information. | `None` |
-| <a id="doxygen-full_sidebar"></a>full_sidebar | When both `generate_treeview` and `disable_index` are set to `True`, then the `full_sidebar` option determines if the side bar is limited to only the treeview area (value `False`) or if it should extend to the full height of the window (value `True`). | `None` |
+| <a id="doxygen-page_outline_panel"></a>page_outline_panel | When `generate_treeview` is set to YES, the `page_outline_panel` option determines if an additional navigation panel is shown at the right hand side of the screen, displaying an outline of the contents of the main page, similar to e.g. https://developer.android.com/reference. | `None` |
+| <a id="doxygen-full_sidebar"></a>full_sidebar | When `generate_treeview` is set to `True`, the `full_sidebar` option determines if the side bar is limited to only the treeview area (value `False`) or if it should extend to the full height of the window (value `True`). | `None` |
| <a id="doxygen-enum_values_per_line"></a>enum_values_per_line | 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. | `None` |
| <a id="doxygen-show_enum_values"></a>show_enum_values | When the `show_enum_values` tag is set doxygen will show the specified enumeration values besides the enumeration mnemonics. | `None` |
| <a id="doxygen-treeview_width"></a>treeview_width | 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. | `None` |
@@ -508,6 +509,7 @@
| <a id="doxygen-group_graphs"></a>group_graphs | If the `group_graphs` tag is set to `True` then Doxygen will generate a graph for groups, showing the direct groups dependencies. | `None` |
| <a id="doxygen-uml_look"></a>uml_look | If the `uml_look` tag is set to `True`, Doxygen will generate inheritance and collaboration diagrams in a style similar to the OMG's Unified Modeling Language. | `None` |
| <a id="doxygen-uml_limit_num_fields"></a>uml_limit_num_fields | If the `uml_look` tag is enabled, the fields and methods are shown inside the class node. | `None` |
+| <a id="doxygen-uml_max_edge_labels"></a>uml_max_edge_labels | If the `uml_look` tag is enabled, field labels are shown along the edge between two class nodes. | `None` |
| <a id="doxygen-dot_uml_details"></a>dot_uml_details | If the `dot_uml_details` tag is set to `False`, Doxygen will show attributes and methods without types and arguments in the UML graphs. | `None` |
| <a id="doxygen-dot_wrap_threshold"></a>dot_wrap_threshold | The `dot_wrap_threshold` tag can be used to set the maximum number of characters to display on a single line. | `None` |
| <a id="doxygen-template_relations"></a>template_relations | If the `template_relations` tag is set to `True` then the inheritance and collaboration graphs will show the relations between templates and their instances. | `None` |
diff --git a/docs/extensions_doc.md b/docs/extensions_doc.md
index d7d6c55..2752c44 100755
--- a/docs/extensions_doc.md
+++ b/docs/extensions_doc.md
@@ -128,7 +128,7 @@
- `@doxygen//:doxygen.bzl`, containing the doxygen macro used to generate the documentation.
- `@doxygen//:Doxyfile.template`, default Doxyfile template used to generate the Doxyfile.
-The extension will create a default configuration for all platforms with the version `1.13.2` of Doxygen.
+The extension will create a default configuration for all platforms with the version `1.14.0` of Doxygen.
You can override this value with a custom one for each supported platform, i.e. _windows_, _mac_, _mac-arm_, _linux_ and _linux-arm_.
```bzl
diff --git a/doxygen/Doxyfile.template b/doxygen/Doxyfile.template
index 2081b05..10418c7 100644
--- a/doxygen/Doxyfile.template
+++ b/doxygen/Doxyfile.template
@@ -1,4 +1,4 @@
-# Doxyfile 1.13.2
+# Doxyfile 1.14.0
# This file describes the settings to be used by the documentation system
# Doxygen (www.doxygen.org) for a project.
@@ -392,8 +392,8 @@
# This tag specifies a list of words that, when matching the start of a word in
# the documentation, will suppress auto links generation, if it is enabled via
-# AUTOLINK_SUPPORT. This list does not affect affect links explicitly created
-# using \# or the \link or commands.
+# AUTOLINK_SUPPORT. This list does not affect links explicitly created using \#
+# or the \link or commands.
# This tag requires that the tag AUTOLINK_SUPPORT is set to YES.
AUTOLINK_IGNORE_WORDS =
@@ -1026,9 +1026,9 @@
#
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl,
-# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.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,
+# *.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 \
@@ -1054,7 +1054,6 @@
*.hxx \
*.hpp \
*.h++ \
- *.ixx \
*.l \
*.cs \
*.d \
@@ -1787,10 +1786,10 @@
# 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: YES.
+# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
-DISABLE_INDEX = 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
@@ -1802,20 +1801,29 @@
# 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.
+# Since the tree basically has more details information than the tab index, you
+# could consider setting DISABLE_INDEX to YES when enabling this option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = YES
-# 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.
+# When GENERATE_TREEVIEW is set to YES, the PAGE_OUTLINE_PANEL option determines
+# if an additional navigation panel is shown at the right hand side of the
+# screen, displaying an outline of the contents of the main page, similar to
+# e.g. https://developer.android.com/reference If GENERATE_TREEVIEW is set to
+# NO, this option has no effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+PAGE_OUTLINE_PANEL = YES
+
+# When GENERATE_TREEVIEW is set to YES, 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 e.g. https://docs.readthedocs.io with more room for
+# contents, but less room for the project logo, title, and description. If
+# GENERATE_TREEVIEW 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.
@@ -2716,6 +2724,15 @@
UML_LIMIT_NUM_FIELDS = 10
+# If the UML_LOOK tag is enabled, field labels are shown along the edge between
+# two class nodes. If there are many fields and many nodes the graph may become
+# too cluttered. The UML_MAX_EDGE_LABELS threshold limits the number of items to
+# make the size more manageable. Set this to 0 for no limit.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag UML_LOOK is set to YES.
+
+UML_MAX_EDGE_LABELS = 10
+
# If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and
# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
# tag is set to YES, Doxygen will add type and arguments for attributes and
diff --git a/doxygen/doxygen.bzl b/doxygen/doxygen.bzl
index f82572d..fcf676e 100644
--- a/doxygen/doxygen.bzl
+++ b/doxygen/doxygen.bzl
@@ -362,6 +362,7 @@
eclipse_doc_id = None,
disable_index = None,
generate_treeview = None,
+ page_outline_panel = None,
full_sidebar = None,
enum_values_per_line = None,
show_enum_values = None,
@@ -455,6 +456,7 @@
group_graphs = None,
uml_look = None,
uml_limit_num_fields = None,
+ uml_max_edge_labels = None,
dot_uml_details = None,
dot_wrap_threshold = None,
template_relations = None,
@@ -810,7 +812,8 @@
eclipse_doc_id: A unique identifier for the Eclipse help plugin.
disable_index: 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.
generate_treeview: The `generate_treeview` tag is used to specify whether a tree-like index structure should be generated to display hierarchical information.
- full_sidebar: When both `generate_treeview` and `disable_index` are set to `True`, then the `full_sidebar` option determines if the side bar is limited to only the treeview area (value `False`) or if it should extend to the full height of the window (value `True`).
+ page_outline_panel: When `generate_treeview` is set to YES, the `page_outline_panel` option determines if an additional navigation panel is shown at the right hand side of the screen, displaying an outline of the contents of the main page, similar to e.g. https://developer.android.com/reference.
+ full_sidebar: When `generate_treeview` is set to `True`, the `full_sidebar` option determines if the side bar is limited to only the treeview area (value `False`) or if it should extend to the full height of the window (value `True`).
enum_values_per_line: 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.
show_enum_values: When the `show_enum_values` tag is set doxygen will show the specified enumeration values besides the enumeration mnemonics.
treeview_width: 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.
@@ -903,6 +906,7 @@
group_graphs: If the `group_graphs` tag is set to `True` then Doxygen will generate a graph for groups, showing the direct groups dependencies.
uml_look: If the `uml_look` tag is set to `True`, Doxygen will generate inheritance and collaboration diagrams in a style similar to the OMG's Unified Modeling Language.
uml_limit_num_fields: If the `uml_look` tag is enabled, the fields and methods are shown inside the class node.
+ uml_max_edge_labels: If the `uml_look` tag is enabled, field labels are shown along the edge between two class nodes.
dot_uml_details: If the `dot_uml_details` tag is set to `False`, Doxygen will show attributes and methods without types and arguments in the UML graphs.
dot_wrap_threshold: The `dot_wrap_threshold` tag can be used to set the maximum number of characters to display on a single line.
template_relations: If the `template_relations` tag is set to `True` then the inheritance and collaboration graphs will show the relations between templates and their instances.
@@ -1120,6 +1124,7 @@
_add_generic_configuration(configurations, "ECLIPSE_DOC_ID", eclipse_doc_id)
_add_generic_configuration(configurations, "DISABLE_INDEX", disable_index)
_add_generic_configuration(configurations, "GENERATE_TREEVIEW", generate_treeview)
+ _add_generic_configuration(configurations, "PAGE_OUTLINE_PANEL", page_outline_panel)
_add_generic_configuration(configurations, "FULL_SIDEBAR", full_sidebar)
_add_generic_configuration(configurations, "ENUM_VALUES_PER_LINE", enum_values_per_line)
_add_generic_configuration(configurations, "SHOW_ENUM_VALUES", show_enum_values)
@@ -1213,6 +1218,7 @@
_add_generic_configuration(configurations, "GROUP_GRAPHS", group_graphs)
_add_generic_configuration(configurations, "UML_LOOK", uml_look)
_add_generic_configuration(configurations, "UML_LIMIT_NUM_FIELDS", uml_limit_num_fields)
+ _add_generic_configuration(configurations, "UML_MAX_EDGE_LABELS", uml_max_edge_labels)
_add_generic_configuration(configurations, "DOT_UML_DETAILS", dot_uml_details)
_add_generic_configuration(configurations, "DOT_WRAP_THRESHOLD", dot_wrap_threshold)
_add_generic_configuration(configurations, "TEMPLATE_RELATIONS", template_relations)
diff --git a/extensions.bzl b/extensions.bzl
index 555884c..04545be 100644
--- a/extensions.bzl
+++ b/extensions.bzl
@@ -278,11 +278,11 @@
name = attr.name
default_configurations = {
- "windows": struct(version = "1.13.2", sha256 = "dedbcf1d05911afc003989d33194ab95539e2ef4535cc00143b5917c22614406", executable = ""),
- "mac": struct(version = "1.13.2", sha256 = "dc981a4212875e8c6b81727eb43bb634167df0d4bc1681fb9053cc850e918acf", executable = ""),
- "mac-arm": struct(version = "1.13.2", sha256 = "dc981a4212875e8c6b81727eb43bb634167df0d4bc1681fb9053cc850e918acf", executable = ""),
- "linux": struct(version = "1.13.2", sha256 = "f2c0a349403bc5b5ade3f501301e32b49ea31b3182666954bc398452fbc0dd1c", executable = ""),
- "linux-arm": struct(version = "1.13.2", sha256 = "f2c0a349403bc5b5ade3f501301e32b49ea31b3182666954bc398452fbc0dd1c", executable = ""),
+ "windows": struct(version = "1.14.0", sha256 = "3843742c604e145dab26f74ebd386af0656bc2feb6f834c12c1abb7b3c019d8b", executable = ""),
+ "mac": struct(version = "1.14.0", sha256 = "ad2c71cb286100d4eaccd0b9d92751c88c4bd0501990f7eccc50aa946f827dc7", executable = ""),
+ "mac-arm": struct(version = "1.14.0", sha256 = "ad2c71cb286100d4eaccd0b9d92751c88c4bd0501990f7eccc50aa946f827dc7", executable = ""),
+ "linux": struct(version = "1.14.0", sha256 = "e5d6ae24d0bf3f0cdc4d8f146726b89ca323922f19441af99b1872d503665ad6", executable = ""),
+ "linux-arm": struct(version = "1.14.0", sha256 = "e5d6ae24d0bf3f0cdc4d8f146726b89ca323922f19441af99b1872d503665ad6", executable = ""),
}
# Otherwise, add all the configurations (version and sha256) for each platform
@@ -337,7 +337,7 @@
- `@doxygen//:doxygen.bzl`, containing the doxygen macro used to generate the documentation.
- `@doxygen//:Doxyfile.template`, default Doxyfile template used to generate the Doxyfile.
-The extension will create a default configuration for all platforms with the version `1.13.2` of Doxygen.
+The extension will create a default configuration for all platforms with the version `1.14.0` of Doxygen.
You can override this value with a custom one for each supported platform, i.e. _windows_, _mac_, _mac-arm_, _linux_ and _linux-arm_.
```bzl