Skip to content

Commit d9abec0

Browse files
committed
JAVA-2665: Add DochubTaglet to support links from Javadoc to http://dochub.mongodb.org
1 parent 3b0a56e commit d9abec0

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

build.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ configure(subprojects.findAll { it.name != 'util' }) {
116116
options.links 'http://docs.oracle.com/javase/7/docs/api/'
117117
options.tagletPath single(project(':util').sourceSets.main.output.classesDirs)
118118
options.taglets 'ManualTaglet'
119+
options.taglets 'DochubTaglet'
119120
options.taglets 'ServerReleaseTaglet'
120121
options.encoding = 'UTF-8'
121122
options.charSet 'UTF-8'

util/src/main/DochubTaglet.java

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
/*
2+
* Copyright 2017 MongoDB, Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
import com.sun.tools.doclets.Taglet;
18+
19+
import java.util.Map;
20+
21+
public class DochubTaglet extends DocTaglet {
22+
23+
public static void register(final Map<String, Taglet> tagletMap) {
24+
DochubTaglet t = new DochubTaglet();
25+
tagletMap.put(t.getName(), t);
26+
}
27+
28+
public String getName() {
29+
return "mongodb.driver.dochub";
30+
}
31+
32+
@Override
33+
protected String getHeader() {
34+
return "MongoDB documentation";
35+
}
36+
37+
@Override
38+
protected String getBaseDocURI() {
39+
return "http://dochub.mongodb.org/";
40+
}
41+
42+
}

0 commit comments

Comments
 (0)