Merged
Conversation
docs: Fixed and updated README.md file.
…erated by it." This reverts commit e126910.
revert: "style: Reformatted Doxyfile to use nice default tempalte gen…
- switch to use `main` branch instead of `master`; - skip running on branches by default (except for direct pushes to `develop` or `main).
- use XML line-breaks; - made `R"()"` literals more unambiguous by using `~~~` prefixes and suffixes.
fix: default templates fixes:
… tags from merges.
ci: fix getting only first parent when using `git describe`, it skips tags from merges.
Doxygen entities of "kind" equal to "variable" with empty `<type>` child tag, which are mapped to internal Kind::JAVAENUMCONSTANT (Java enums constants) were written as "enum constant" (with space) in the generated links URLs. It causes links to be broken. Spaces must be replaced with `-` instead of space, this is what Markdown processors use to replace spaces with in generated anchors.
fix: Java enum constants links were broken.
- Wrong formatting in the documentation line for `linkAndInlineCodeAsHTML`; - Sorted all tables alphabetically; - Added missing documentation values: `useFolders` and `templateKindJavaEnum`. - Added mapping for missing `templateKindJavaEnum` value, it allows configuring it from JSON and dumping default JSON config. - Sorted `Config` class alphabetically (with bool values at the end), same for mapping between variables and their names. Makes navigation easier.
docs: fixed chapter about config values
When processing links in Java code (`{@link class#method(argType1, argType2, argType3)}`) Doxygen wraps them first in the `<computeroutput>` tag (a Doxygen semantic for `<code>` tag in Markdown) and inside in the `<ref>` tag (used for creating various links).
It leads to putting links inside code, which is not valid, those links will not be parsed, unless `linkAndInlineCodeAsHTML` config option is used (which can be also problematic in some cases).
Added a hack-tweak that when we encounter such case (a `<computeroutput>` tag with a single `<ref>` tag in it), and `linkAndInlineCodeAsHTML` option is not set, we effectively inverting them, by putting links braces over code marks (backtick).
…within_code feat: Fix Java links being inside code blocks.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.