Specify documentation except for listed languages. #10809
Conversation
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
With the commands `\~` and `\~LanguageId` it is possible to specify comments for one or all languages. When one wants to write the documentation for the languages except for some specified this needs a complete set of commands, with this enhancement this can be done with one command.
doxygen
reviewed
Apr 21, 2024
doc/commands.dox
Outdated
|
|
||
| <hr> | ||
| \section cmdtilde \\~[LanguageId] | ||
| \section cmdtilde \\~[LanguageId] or \\~'{'LanguageId [,LanguageId]*'}' |
Owner
There was a problem hiding this comment.
I have some concerns.
- Is there a use-case for this? I can only think about using it as fallback telling some translation is missing.
- I think the
\~langand\~{lang}look a bit too similar, and it is not intuitively clear one is the negation of the other, maybe\~!{lang}would be more clear. - From a usability point of view, I would prefer something like
\~dutch Nederlands \~german Deutsch \~else Fallback to e.g. english text \~.
Collaborator
Author
There was a problem hiding this comment.
- No there is not a direct use case, but it is a bit strange that one cannot easily signal the fallback telling some translation is missing.
- They are indeed quite similar,
\~!{lang}would indeed be more clear. - I thought about this as well but decided against it as
- one has to keep track of which language have already been selected and reset the list when
\~is given / end of a comment block - the current solution gives also a possibility to have
\~dutch Nederlands \~german Deutsch \~{dutch} some "Fallback" even for a previous handled language (probably quite unusual / uncommon but gives more flexibility) \~.
- one has to keep track of which language have already been selected and reset the list when
I think best is to implement the solution mentioned under 2.
Better distinction between "except" usage and "normal usage" du to commands `\~!` and `\~`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
With the commands
\~and\~LanguageIdit is possible to specify comments for one or all languages. When one wants to write the documentation for the languages except for some specified this needs a complete set of commands, with this enhancement this can be done with one command.Example: example.tar.gzAdjusted example (due to bc508bd) : example1.tar.gz