javadoc: Allow javadoc targets to reference other javadoc targets
#958
Conversation
By setting the `doc_url` attribute on a `javadoc` target, other targets can depend on it via `doc_deps` and have references resolved automatically via appropriate `-linkoffline` arguments passed to javadoc.
fmeum
requested review from
jin,
Wyverald,
shs96c and
cheister
as code owners
|
@shs96c Happy to bikeshed any of the new API bits. I briefly considered merging |
|
I'm about to head to TPAC soon, so it's going to take a few days to get to do a proper review of this, but it seems fine from a quick scan. I do appreciate minimal magic in rulesets, so not merging |
| @@ -113,7 +121,10 @@ def maven_export( | |||
| tags = [], | |||
| testonly = False, | |||
| javadocopts = [], | |||
| classifier_artifacts = {}): | |||
| classifier_artifacts = {}, | |||
| *, | |||
There was a problem hiding this comment.
I've not seen this syntax before. How interesting. Do we need this? The tests pass, so I guess it's fine, if a little odd.
There was a problem hiding this comment.
This syntax enforces that all arguments that come after it are only passed as keyword arguments, not positional arguments. I usually use it for functions that have more than say two keyword parameters, just to guard against accidentally passing in unexpected arguments positionally.
By setting the
doc_urlattribute on ajavadoctarget, other targets can depend on it viadoc_depsand have references resolved automatically via appropriate-linkofflinearguments passed to javadoc.