Skip to content

Commit 43194d4

Browse files
SQiShERSQiShER
committed
Added plugin to allow Markdown in JavaDocs
1 parent 78011f8 commit 43194d4

File tree

3 files changed

+54
-51
lines changed

3 files changed

+54
-51
lines changed

‎pom.xml‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!-- ~ Copyright 2012 Daniel Bechler ~ ~ Licensed under the Apache License,
3-
Version 2.0 (the "License"); ~ you may not use this file except in compliance
4-
with the License. ~ You may obtain a copy of the License at ~ ~ http://www.apache.org/licenses/LICENSE-2.0
5-
~ ~ Unless required by applicable law or agreed to in writing, software ~
6-
distributed under the License is distributed on an "AS IS" BASIS, ~ WITHOUT
7-
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. ~ See the
8-
License for the specific language governing permissions and ~ limitations
9-
under the License. -->
2+
<!--
3+
~ Copyright 2014 Daniel Bechler
4+
~
5+
~ Licensed under the Apache License, Version 2.0 (the "License");
6+
~ you may not use this file except in compliance with the License.
7+
~ You may obtain a copy of the License at
8+
~
9+
~ http://www.apache.org/licenses/LICENSE-2.0
10+
~
11+
~ Unless required by applicable law or agreed to in writing, software
12+
~ distributed under the License is distributed on an "AS IS" BASIS,
13+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
~ See the License for the specific language governing permissions and
15+
~ limitations under the License.
16+
-->
1017

11-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
18+
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
1219
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
1320

1421
<parent>
@@ -65,7 +72,6 @@
6572
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
6673
<project.jdk>1.5</project.jdk>
6774
</properties>
68-
6975
<build>
7076
<plugins>
7177
<plugin>
@@ -89,20 +95,6 @@
8995
</dependency>
9096
</dependencies>
9197
</plugin>
92-
<plugin>
93-
<artifactId>maven-javadoc-plugin</artifactId>
94-
<executions>
95-
<execution>
96-
<phase>site</phase>
97-
<goals>
98-
<goal>javadoc</goal>
99-
</goals>
100-
</execution>
101-
</executions>
102-
<configuration>
103-
<encoding>UTF-8</encoding>
104-
</configuration>
105-
</plugin>
10698
<plugin>
10799
<artifactId>maven-release-plugin</artifactId>
108100
<configuration>
@@ -426,30 +418,38 @@
426418
<artifactId>maven-pmd-plugin</artifactId>
427419
<version>3.0.1</version>
428420
<configuration>
429-
<linkXref>true</linkXref>
430421
<sourceEncoding>utf-8</sourceEncoding>
431422
<minimumTokens>100</minimumTokens>
432423
<targetJdk>${project.jdk}</targetJdk>
433-
<excludes>
434-
<exclude>**/*Bean.java</exclude>
435-
<exclude>**/generated/*.java</exclude>
436-
</excludes>
437-
<excludeRoots>
438-
<excludeRoot>target/generated-sources/stubs</excludeRoot>
439-
</excludeRoots>
440424
</configuration>
441425
</plugin>
442426
<plugin>
443427
<groupId>org.codehaus.mojo</groupId>
444428
<artifactId>cobertura-maven-plugin</artifactId>
445429
<version>2.6</version>
446430
</plugin>
431+
<plugin>
432+
<groupId>org.apache.maven.plugins</groupId>
433+
<artifactId>maven-jxr-plugin</artifactId>
434+
<version>2.4</version>
435+
</plugin>
447436
<plugin>
448437
<artifactId>maven-javadoc-plugin</artifactId>
449438
<configuration>
450439
<encoding>UTF-8</encoding>
440+
<doclet>ch.raffael.doclets.pegdown.PegdownDoclet</doclet>
441+
<docletArtifact>
442+
<groupId>ch.raffael.pegdown-doclet</groupId>
443+
<artifactId>pegdown-doclet</artifactId>
444+
<version>1.1</version>
445+
</docletArtifact>
446+
<useStandardDocletOptions>true</useStandardDocletOptions>
451447
</configuration>
452448
</plugin>
449+
<plugin>
450+
<artifactId>maven-project-info-reports-plugin</artifactId>
451+
<version>2.7</version>
452+
</plugin>
453453
</plugins>
454454
</reporting>
455455
</project>

‎src/integration-test/java/de/danielbechler/diff/issues/issue15/GraphNode.java‎

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012 Daniel Bechler
2+
* Copyright 2014 Daniel Bechler
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -16,11 +16,15 @@
1616

1717
package de.danielbechler.diff.issues.issue15;
1818

19-
import org.slf4j.*;
19+
import org.slf4j.Logger;
20+
import org.slf4j.LoggerFactory;
2021

21-
import java.util.*;
22+
import java.util.HashMap;
23+
import java.util.LinkedList;
24+
import java.util.List;
25+
import java.util.Map;
2226

23-
import static java.util.Arrays.*;
27+
import static java.util.Arrays.asList;
2428

2529
/**
2630
* @author https://github.com/oplohmann (original author)
@@ -39,6 +43,11 @@ public class GraphNode
3943
private GraphNode parent;
4044
private GraphNode directReference;
4145

46+
public GraphNode(final int id)
47+
{
48+
this(id, null);
49+
}
50+
4251
public GraphNode(final int id, final String value)
4352
{
4453
if (id == -1)
@@ -50,13 +59,8 @@ public GraphNode(final int id, final String value)
5059
this.value = value;
5160
}
5261

53-
public GraphNode(final int id)
54-
{
55-
this(id, null);
56-
}
57-
5862
/**
59-
* @see GraphNode(int, String)
63+
* @see #GraphNode(int, String)
6064
* @deprecated You should always provide an ID.
6165
*/
6266
@Deprecated
@@ -66,7 +70,7 @@ public GraphNode(final String value)
6670
}
6771

6872
/**
69-
* @see GraphNode(int, String)
73+
* @see #GraphNode(int, String)
7074
* @deprecated You should always provide an ID.
7175
*/
7276
@Deprecated
@@ -75,11 +79,6 @@ public GraphNode()
7579
this(-1, null);
7680
}
7781

78-
public void setDirectReference(final GraphNode directReference)
79-
{
80-
this.directReference = directReference;
81-
}
82-
8382
public void addChild(final GraphNode child)
8483
{
8584
addChildren(child);
@@ -115,6 +114,11 @@ public GraphNode getDirectReference()
115114
return directReference;
116115
}
117116

117+
public void setDirectReference(final GraphNode directReference)
118+
{
119+
this.directReference = directReference;
120+
}
121+
118122
public List<GraphNode> getChildren()
119123
{
120124
return children;

‎src/main/java/de/danielbechler/diff/ObjectDiffer.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012 Daniel Bechler
2+
* Copyright 2014 Daniel Bechler
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -40,9 +40,8 @@ public ObjectDiffer(final DifferDispatcher differDispatcher)
4040
* Recursively inspects the given objects and returns a node representing their differences. Both objects
4141
* have be have the same type.
4242
*
43-
* @param working This object will be treated as the successor of the <code>base</code> object.
43+
* @param working This object will be treated as the successor of the `base` object.
4444
* @param base This object will be treated as the predecessor of the <code>working</code> object.
45-
* @param <T> The type of the objects to compare.
4645
* @return A node representing the differences between the given objects.
4746
*/
4847
public <T> DiffNode compare(final T working, final T base)

0 commit comments

Comments
 (0)