feat(generator): link each method input and output types #7665
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
The protobuf documentation seems to use reference-style markdown links for protos in the comments, i.e., each reference to `Foo` is formatted as `[Foo][google.blah.blah.v1.Foo]`. This formatting is very distracting if left verbatim, but it can be turned into a link if we define `google.blah.blah.v1.Foo` as a link reference in Doxygen's markdown. With this change the input and output types of each method get such reference link definitions. The definitions themselves are not visible, but they make the generated Doxygen output easier to read. This does not solve the problem when the referenced entity is not an input or output type of the method, or when it references another method. But it works in enough cases to make the change worthwhile.
google-cla
bot
added
the
cla: yes
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
Codecov Report
@@ Coverage Diff @@
## main #7665 +/- ##
==========================================
- Coverage 95.28% 95.28% -0.01%
==========================================
Files 1254 1254
Lines 113284 113313 +29
==========================================
+ Hits 107946 107969 +23
- Misses 5338 5344 +6
Continue to review full report at Codecov.
|
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
|
Google Cloud Build Logs
ℹ️ NOTE: Kokoro logs are linked from "Details" below. |
|
Sorry about the churn, should be in a good place to review now. |
dbolduc
approved these changes
Nov 24, 2021
|
You are adding reference links for many methods that don't need them, but I think it's harmless. |
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 protobuf documentation seems to use reference-style markdown links
for protos in the comments, i.e., each reference to
Foois formattedas
[Foo][google.blah.blah.v1.Foo]. This formatting is verydistracting if left verbatim, but it can be turned into a link if we
define
google.blah.blah.v1.Fooas a link reference in Doxygen'smarkdown.
With this change the input and output types of each method get such
reference link definitions. The definitions themselves are not visible,
but they make the generated Doxygen output easier to read.
This does not solve the problem when the referenced entity is not an
input or output type of the method, or when it references another
method. But it works in enough cases to make the change worthwhile.
Part of the work for #7664
This change is