Skip to content

Commit 575b1d0

Browse files
chingor13chingor13
authored
Fix javadoc linking (#4995)
* Cleanup maven-javadoc-plugin configs * Link proto artifact javadoc to protobuf javadocs * offlineLink from grpc->proto artifact * common protos link * Move common links to the parent * google-cloud client can link to multiple proto/grpc artifact docs * Move protolinks to parent * Configure all grpc->proto artifact offline links * Add offline links for all google-cloud-x clients to the proto/grpc artifacts * Fix dataproc artifact version * Make google-cloud-clients link to google-api-grpc docs * Put groups config back * Put versions variables back * Build the javadoc artifact for release * Add javadoc link config to new_client.py
1 parent 388309e commit 575b1d0

101 files changed

Lines changed: 2541 additions & 58 deletions

File tree

  • google-api-grpc
    • grpc-google-cloud-asset-v1beta1
    • grpc-google-cloud-asset-v1
    • grpc-google-cloud-automl-v1beta1
    • grpc-google-cloud-bigquerydatatransfer-v1
    • grpc-google-cloud-bigquerystorage-v1beta1
    • grpc-google-cloud-bigtable-admin-v2
    • grpc-google-cloud-bigtable-v2
    • grpc-google-cloud-container-v1
    • grpc-google-cloud-containeranalysis-v1beta1
    • grpc-google-cloud-datalabeling-v1beta1
    • grpc-google-cloud-dataproc-v1beta2
    • grpc-google-cloud-dataproc-v1
    • grpc-google-cloud-dialogflow-v2beta1
    • grpc-google-cloud-dialogflow-v2
    • grpc-google-cloud-dlp-v2
    • grpc-google-cloud-error-reporting-v1beta1
    • grpc-google-cloud-firestore-admin-v1
    • grpc-google-cloud-firestore-v1beta1
    • grpc-google-cloud-firestore-v1
    • grpc-google-cloud-iamcredentials-v1
    • grpc-google-cloud-iot-v1
    • grpc-google-cloud-kms-v1
    • grpc-google-cloud-language-v1beta2
    • grpc-google-cloud-language-v1
    • grpc-google-cloud-logging-v2
    • grpc-google-cloud-monitoring-v3
    • grpc-google-cloud-os-login-v1
    • grpc-google-cloud-pubsub-v1
    • grpc-google-cloud-redis-v1beta1
    • grpc-google-cloud-redis-v1
    • grpc-google-cloud-scheduler-v1beta1
    • grpc-google-cloud-scheduler-v1
    • grpc-google-cloud-securitycenter-v1beta1
    • grpc-google-cloud-securitycenter-v1
    • grpc-google-cloud-spanner-admin-database-v1
    • grpc-google-cloud-spanner-admin-instance-v1
    • grpc-google-cloud-spanner-v1
    • grpc-google-cloud-speech-v1beta1
    • grpc-google-cloud-speech-v1p1beta1
    • grpc-google-cloud-speech-v1
    • grpc-google-cloud-talent-v4beta1
    • grpc-google-cloud-tasks-v2beta2
    • grpc-google-cloud-tasks-v2beta3
    • grpc-google-cloud-tasks-v2
    • grpc-google-cloud-texttospeech-v1beta1
    • grpc-google-cloud-texttospeech-v1
    • grpc-google-cloud-trace-v1
    • grpc-google-cloud-trace-v2
    • grpc-google-cloud-translate-v3beta1
    • grpc-google-cloud-video-intelligence-v1beta1
    • grpc-google-cloud-video-intelligence-v1beta2
    • grpc-google-cloud-video-intelligence-v1p1beta1
    • grpc-google-cloud-video-intelligence-v1p2beta1
    • grpc-google-cloud-video-intelligence-v1p3beta1
    • grpc-google-cloud-video-intelligence-v1
    • grpc-google-cloud-vision-v1p1beta1
    • grpc-google-cloud-vision-v1p2beta1
    • grpc-google-cloud-vision-v1p3beta1
    • grpc-google-cloud-vision-v1p4beta1
    • grpc-google-cloud-vision-v1
    • grpc-google-cloud-webrisk-v1beta1
    • grpc-google-cloud-websecurityscanner-v1alpha
    • pom.xml
  • google-cloud-clients
  • utilities/templates

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎google-api-grpc/grpc-google-cloud-asset-v1/pom.xml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,25 @@
2828
<scope>compile</scope>
2929
</dependency>
3030
</dependencies>
31+
<reporting>
32+
<plugins>
33+
<plugin>
34+
<groupId>org.apache.maven.plugins</groupId>
35+
<artifactId>maven-javadoc-plugin</artifactId>
36+
<version>3.1.0</version>
37+
<configuration>
38+
<show>protected</show>
39+
<nohelp>true</nohelp>
40+
<doclint>none</doclint>
41+
<splitindex>true</splitindex>
42+
<offlineLinks>
43+
<offlineLink>
44+
<url>${project.javadoc.protobufBaseURL}</url>
45+
<location>../../../../proto-google-cloud-asset-v1/target/site/apidocs/</location>
46+
</offlineLink>
47+
</offlineLinks>
48+
</configuration>
49+
</plugin>
50+
</plugins>
51+
</reporting>
3152
</project>

‎google-api-grpc/grpc-google-cloud-asset-v1beta1/pom.xml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,25 @@
2828
<scope>compile</scope>
2929
</dependency>
3030
</dependencies>
31+
<reporting>
32+
<plugins>
33+
<plugin>
34+
<groupId>org.apache.maven.plugins</groupId>
35+
<artifactId>maven-javadoc-plugin</artifactId>
36+
<version>3.1.0</version>
37+
<configuration>
38+
<show>protected</show>
39+
<nohelp>true</nohelp>
40+
<doclint>none</doclint>
41+
<splitindex>true</splitindex>
42+
<offlineLinks>
43+
<offlineLink>
44+
<url>${project.javadoc.protobufBaseURL}</url>
45+
<location>../../../../proto-google-cloud-asset-v1beta1/target/site/apidocs/</location>
46+
</offlineLink>
47+
</offlineLinks>
48+
</configuration>
49+
</plugin>
50+
</plugins>
51+
</reporting>
3152
</project>

‎google-api-grpc/grpc-google-cloud-automl-v1beta1/pom.xml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,25 @@
2828
<scope>compile</scope>
2929
</dependency>
3030
</dependencies>
31+
<reporting>
32+
<plugins>
33+
<plugin>
34+
<groupId>org.apache.maven.plugins</groupId>
35+
<artifactId>maven-javadoc-plugin</artifactId>
36+
<version>3.1.0</version>
37+
<configuration>
38+
<show>protected</show>
39+
<nohelp>true</nohelp>
40+
<doclint>none</doclint>
41+
<splitindex>true</splitindex>
42+
<offlineLinks>
43+
<offlineLink>
44+
<url>${project.javadoc.protobufBaseURL}</url>
45+
<location>../../../../proto-google-cloud-automl-v1beta1/target/site/apidocs/</location>
46+
</offlineLink>
47+
</offlineLinks>
48+
</configuration>
49+
</plugin>
50+
</plugins>
51+
</reporting>
3152
</project>

‎google-api-grpc/grpc-google-cloud-bigquerydatatransfer-v1/pom.xml‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,25 @@
2828
<scope>compile</scope>
2929
</dependency>
3030
</dependencies>
31-
</project>
31+
<reporting>
32+
<plugins>
33+
<plugin>
34+
<groupId>org.apache.maven.plugins</groupId>
35+
<artifactId>maven-javadoc-plugin</artifactId>
36+
<version>3.1.0</version>
37+
<configuration>
38+
<show>protected</show>
39+
<nohelp>true</nohelp>
40+
<doclint>none</doclint>
41+
<splitindex>true</splitindex>
42+
<offlineLinks>
43+
<offlineLink>
44+
<url>${project.javadoc.protobufBaseURL}</url>
45+
<location>../../../../proto-google-cloud-bigquerydatatransfer-v1/target/site/apidocs/</location>
46+
</offlineLink>
47+
</offlineLinks>
48+
</configuration>
49+
</plugin>
50+
</plugins>
51+
</reporting>
52+
</project>

‎google-api-grpc/grpc-google-cloud-bigquerystorage-v1beta1/pom.xml‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,25 @@
2828
<scope>compile</scope>
2929
</dependency>
3030
</dependencies>
31-
</project>
31+
<reporting>
32+
<plugins>
33+
<plugin>
34+
<groupId>org.apache.maven.plugins</groupId>
35+
<artifactId>maven-javadoc-plugin</artifactId>
36+
<version>3.1.0</version>
37+
<configuration>
38+
<show>protected</show>
39+
<nohelp>true</nohelp>
40+
<doclint>none</doclint>
41+
<splitindex>true</splitindex>
42+
<offlineLinks>
43+
<offlineLink>
44+
<url>${project.javadoc.protobufBaseURL}</url>
45+
<location>../../../../proto-google-cloud-bigquerystorage-v1beta1/target/site/apidocs/</location>
46+
</offlineLink>
47+
</offlineLinks>
48+
</configuration>
49+
</plugin>
50+
</plugins>
51+
</reporting>
52+
</project>

‎google-api-grpc/grpc-google-cloud-bigtable-admin-v2/pom.xml‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,25 @@
2828
<scope>compile</scope>
2929
</dependency>
3030
</dependencies>
31-
</project>
31+
<reporting>
32+
<plugins>
33+
<plugin>
34+
<groupId>org.apache.maven.plugins</groupId>
35+
<artifactId>maven-javadoc-plugin</artifactId>
36+
<version>3.1.0</version>
37+
<configuration>
38+
<show>protected</show>
39+
<nohelp>true</nohelp>
40+
<doclint>none</doclint>
41+
<splitindex>true</splitindex>
42+
<offlineLinks>
43+
<offlineLink>
44+
<url>${project.javadoc.protobufBaseURL}</url>
45+
<location>../../../../proto-google-cloud-bigtable-admin-v2/target/site/apidocs/</location>
46+
</offlineLink>
47+
</offlineLinks>
48+
</configuration>
49+
</plugin>
50+
</plugins>
51+
</reporting>
52+
</project>

‎google-api-grpc/grpc-google-cloud-bigtable-v2/pom.xml‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,25 @@
2828
<scope>compile</scope>
2929
</dependency>
3030
</dependencies>
31-
</project>
31+
<reporting>
32+
<plugins>
33+
<plugin>
34+
<groupId>org.apache.maven.plugins</groupId>
35+
<artifactId>maven-javadoc-plugin</artifactId>
36+
<version>3.1.0</version>
37+
<configuration>
38+
<show>protected</show>
39+
<nohelp>true</nohelp>
40+
<doclint>none</doclint>
41+
<splitindex>true</splitindex>
42+
<offlineLinks>
43+
<offlineLink>
44+
<url>${project.javadoc.protobufBaseURL}</url>
45+
<location>../../../../proto-google-cloud-bigtable-v2/target/site/apidocs/</location>
46+
</offlineLink>
47+
</offlineLinks>
48+
</configuration>
49+
</plugin>
50+
</plugins>
51+
</reporting>
52+
</project>

‎google-api-grpc/grpc-google-cloud-container-v1/pom.xml‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,25 @@
2828
<scope>compile</scope>
2929
</dependency>
3030
</dependencies>
31-
</project>
31+
<reporting>
32+
<plugins>
33+
<plugin>
34+
<groupId>org.apache.maven.plugins</groupId>
35+
<artifactId>maven-javadoc-plugin</artifactId>
36+
<version>3.1.0</version>
37+
<configuration>
38+
<show>protected</show>
39+
<nohelp>true</nohelp>
40+
<doclint>none</doclint>
41+
<splitindex>true</splitindex>
42+
<offlineLinks>
43+
<offlineLink>
44+
<url>${project.javadoc.protobufBaseURL}</url>
45+
<location>../../../../proto-google-cloud-container-v1/target/site/apidocs/</location>
46+
</offlineLink>
47+
</offlineLinks>
48+
</configuration>
49+
</plugin>
50+
</plugins>
51+
</reporting>
52+
</project>

‎google-api-grpc/grpc-google-cloud-containeranalysis-v1beta1/pom.xml‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,25 @@
2828
<scope>compile</scope>
2929
</dependency>
3030
</dependencies>
31-
</project>
31+
<reporting>
32+
<plugins>
33+
<plugin>
34+
<groupId>org.apache.maven.plugins</groupId>
35+
<artifactId>maven-javadoc-plugin</artifactId>
36+
<version>3.1.0</version>
37+
<configuration>
38+
<show>protected</show>
39+
<nohelp>true</nohelp>
40+
<doclint>none</doclint>
41+
<splitindex>true</splitindex>
42+
<offlineLinks>
43+
<offlineLink>
44+
<url>${project.javadoc.protobufBaseURL}</url>
45+
<location>../../../../proto-google-cloud-containeranalysis-v1beta1/target/site/apidocs/</location>
46+
</offlineLink>
47+
</offlineLinks>
48+
</configuration>
49+
</plugin>
50+
</plugins>
51+
</reporting>
52+
</project>

‎google-api-grpc/grpc-google-cloud-datalabeling-v1beta1/pom.xml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,25 @@
2828
<scope>compile</scope>
2929
</dependency>
3030
</dependencies>
31+
<reporting>
32+
<plugins>
33+
<plugin>
34+
<groupId>org.apache.maven.plugins</groupId>
35+
<artifactId>maven-javadoc-plugin</artifactId>
36+
<version>3.1.0</version>
37+
<configuration>
38+
<show>protected</show>
39+
<nohelp>true</nohelp>
40+
<doclint>none</doclint>
41+
<splitindex>true</splitindex>
42+
<offlineLinks>
43+
<offlineLink>
44+
<url>${project.javadoc.protobufBaseURL}</url>
45+
<location>../../../../proto-google-cloud-datalabeling-v1beta1/target/site/apidocs/</location>
46+
</offlineLink>
47+
</offlineLinks>
48+
</configuration>
49+
</plugin>
50+
</plugins>
51+
</reporting>
3152
</project>

0 commit comments

Comments
 (0)