FilesExpand file tree

 master

/

DocTaglet.java

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

82 lines (65 loc) · 2.12 KB

 master

/

DocTaglet.java

Copy path

Top

File metadata and controls

• Code
• Blame

82 lines (65 loc) · 2.12 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

/*

* Copyright (c) 2008-2014 MongoDB, Inc.

*

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

*

* http://www.apache.org/licenses/LICENSE-2.0

*

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

*/

import com.sun.javadoc.Tag;

import com.sun.tools.doclets.Taglet;

public abstract class DocTaglet implements Taglet {

public boolean inConstructor() {

return true;

}

public boolean inField() {

return true;

}

public boolean inMethod() {

return true;

}

public boolean inOverview() {

return true;

}

public boolean inPackage() {

return true;

}

public boolean inType() {

return true;

}

public boolean isInlineTag() {

return false;

}

public String toString(final Tag[] tags) {

if (tags.length == 0) {

return null;

}

StringBuilder buf = new StringBuilder(String.format("\n<dl><dt><span class=\"strong\">%s</span></dt>\n", getHeader()));

for (Tag t : tags) {

buf.append(" <dd>").append(genLink(t.text())).append("</dd>\n");

}

return buf.toString();

}

protected abstract String getHeader();

public String toString(final Tag tag) {

return toString(new Tag[]{tag});

}

protected String genLink(final String text) {

String relativePath = text;

String display = text;

int firstSpace = text.indexOf(' ');

if (firstSpace != -1) {

relativePath = text.substring(0, firstSpace);

display = text.substring(firstSpace, text.length()).trim();

}

return String.format("<a href='%s%s'>%s</a>", getBaseDocURI(), relativePath, display);

}

protected abstract String getBaseDocURI();

}