Minor Comment Fixes #3196
Merged
Minor Comment Fixes #3196
Conversation
This file contains 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
bernardnormier
approved these changes
Nov 26, 2024
| @@ -113,7 +113,7 @@ module Ice | |||
| } | |||
|
|
|||
| /// This interface should be implemented by services implementing the <code>Ice::Locator interface</code>. It should | |||
| /// be advertised through an Ice object with the identity <code>`Ice/LocatorFinder'</code>. This allows clients to | |||
| /// be advertised through an Ice object with the identity <code>'Ice/LocatorFinder'</code>. This allows clients to | |||
There was a problem hiding this comment.
Which syntax should be use in doc-comments to insert a string as is? <code>text</code> or back ticks?
There was a problem hiding this comment.
Doxygen seems to support both HTML <code> tags and Markdown backticks:
https://www.doxygen.nl/manual/htmlcmds.html
https://www.doxygen.nl/manual/markdown.html#md_codespan
I'm not sure if there's some subtle difference between them, but obviously we should prefer backticks over xml tags if there's no difference.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The main point of this PR was to fix our usage of asymmetric quotations like
`hello'in our Slice files.These seem to confuse Doxygen, which thinks that they are un-closed code-blocks.
I wrote more about this on my blog, but these need to be removed before we can switch to triple-slash style doc-comments.
While reviewing the generated code, I also stumbled across a couple of things that I fixed in this PR too.
Represent