Skip to content

Commit c3dbe3d

Browse files
committed
site enhancements.
1 parent 04d1b3e commit c3dbe3d

File tree

2 files changed

+41
-41
lines changed

2 files changed

+41
-41
lines changed

src/site/apt/examples/counting-tags.apt.vm

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Counting Tags
1313

1414
Let us configure the plugin in the <<<pom.xml>>> file like this:
1515

16-
-----
16+
+---+
1717
<project>
1818
...
1919
<reporting>
@@ -67,40 +67,40 @@ Counting Tags
6767
</reporting>
6868
...
6969
</project>
70-
-----
70+
+---+
7171

7272
The Java file we are analyzing is this one:
7373

74-
-----
75-
1: package taglist;
76-
2:
77-
3: /**
78-
4: * NOT_YET_DOCUMENTED
79-
5: */
80-
6: public class Issue
81-
7: {
82-
8: /**
83-
9: * A method.
84-
10: * FIXME Describe what this method does
85-
11: *
86-
12: * @param i DOCUMENT_ME
87-
13: * @return Something useful
88-
14: */
89-
15: public double method(int i)
90-
16: {
91-
17: // <todo> must be implemented
92-
18: return 0;
93-
19: }
94-
20:
95-
21: /**
96-
22: * This method counts FIXME tags in the text.
97-
23: */
98-
24: private int countFixmeTags(String text)
99-
25: {
100-
26: // @todo Implement this later
101-
27: }
102-
28: }
103-
-----
74+
+---+
75+
package taglist;
76+
77+
/**
78+
* NOT_YET_DOCUMENTED
79+
*/
80+
public class Issue
81+
{
82+
/**
83+
* A method.
84+
* FIXME Describe what this method does
85+
*
86+
* @param i DOCUMENT_ME
87+
* @return Something useful
88+
*/
89+
public double method(int i)
90+
{
91+
// <todo> must be implemented
92+
return 0;
93+
}
94+
95+
/**
96+
* This method counts FIXME tags in the text.
97+
*/
98+
private int countFixmeTags(String text)
99+
{
100+
// @todo Implement this later
101+
}
102+
}
103+
+---+
104104

105105
We'll go through the lines in the code and explain what happens and why.
106106

src/site/apt/usage.apt.vm

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Usage
1616

1717
In your <<<pom.xml>>>, insert this segment:
1818

19-
-------------------
19+
+---+
2020
<project>
2121
...
2222
<build>
@@ -34,7 +34,7 @@ Usage
3434
</reporting>
3535
...
3636
</project>
37-
-------------------
37+
+---+
3838

3939
NOTE:
4040
If you like having cross references included you need to define the
@@ -51,7 +51,7 @@ mvn site
5151
The TagList plugin allows tags to be found using three matching methods: exact match, ignore case match, and
5252
regular expression match. The matched tags are grouped into tag classes. For instance:
5353

54-
-------------------
54+
+---+
5555
<project>
5656
...
5757
<build>
@@ -88,14 +88,14 @@ mvn site
8888
</reporting>
8989
...
9090
</project>
91+
+---+
9192

93+
For backwards compatibility with versions prior to the 2.4 release, the legacy tags configuration is supported;
94+
however, only exact matching
95+
is used with legacy configuration.
9296

93-
-------------------
97+
+---+
9498

95-
For backwards compatibility with versions prior to the 2.4 release, the legacy tags configuration is supported; however, only exact matching
96-
is used with legacy configuration.
97-
98-
-------------------
9999
<project>
100100
...
101101
<configuration>
@@ -108,4 +108,4 @@ mvn site
108108
</configuration>
109109
...
110110
</project>
111-
-------------------
111+
+---+

0 commit comments

Comments
 (0)