Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JavaDoc: Use UML doclet version 2 (requires JDK 9) #84

Merged
merged 1 commit into from
Aug 22, 2018
Merged

JavaDoc: Use UML doclet version 2 (requires JDK 9) #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...bles-jdbi/src/main/java/nl/talsmasoftware/enumerables/jdbi/EnumerableArgumentFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2016-2017 Talsma ICT
* Copyright 2016-2018 Talsma ICT
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -36,7 +36,7 @@
* public interface MyDao {
* ...
* {@literal @}SqlQuery("select ... as obj from ... where type = :type")
* List<MyValueObject> queryWithType({@literal @}Bind("type") MyTypeEnumerable type);
* List<MyValueObject> queryWithType({@literal @}Bind("type") MyTypeEnumerable type);
* ...
* }
* </pre>
Expand Down
2 changes: 1 addition & 1 deletion ...es-jdbi3/src/main/java/nl/talsmasoftware/enumerables/jdbi3/EnumerableArgumentFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* public interface MyDao {
* ...
* {@literal @}SqlQuery("select ... as obj from ... where type = :type")
* List&lt;MyValueObject> queryWithType({@literal @}Bind("type") MyTypeEnumerable type);
* List&lt;MyValueObject&gt; queryWithType({@literal @}Bind("type") MyTypeEnumerable type);
* ...
* }
* </pre>
Expand Down
5 changes: 1 addition & 4 deletions enumerables/src/main/java/nl/talsmasoftware/enumerables/Enumerable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2016-2017 Talsma ICT
* Copyright 2016-2018 Talsma ICT
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -59,9 +59,6 @@
* <p>
* TODO: Talk about values(), ordinal(), and other enum concepts.
* TODO: Document an example of how using it.
* <p>
* Here is a generated UML class diagram for this core <code>Enumerable</code> class:<br>
* <center><img src="package.svg" alt="Class diagram of enumerables package"></center>
*
* @author Sjoerd Talsma
*/
Expand Down
4 changes: 1 addition & 3 deletions enumerables/src/main/java/nl/talsmasoftware/enumerables/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2016-2017 Talsma ICT
* Copyright 2016-2018 Talsma ICT
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -31,8 +31,6 @@
* but also offers a possibility to represent <em>yet unknown additional values</em> by parsing them.
* In fact; parsing a known value results in the single constant reference.
* Same goes for serialization and deserialization.
* <p>
* Class diagram for this package:<br><center><img src="package.svg" alt="package class diagram"></center>
*
* @author Sjoerd Talsma
*/
Expand Down
13 changes: 4 additions & 9 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
<coveralls-maven-plugin.version>4.3.0</coveralls-maven-plugin.version>
<nexus-staging-maven-plugin.version>1.6.8</nexus-staging-maven-plugin.version>
<buildnumber-maven-plugin.version>1.4</buildnumber-maven-plugin.version>
<umldoclet.version>1.0.18</umldoclet.version>
<umldoclet.version>2.0.0-rc.2</umldoclet.version>
</properties>

<dependencies>
Expand Down Expand Up @@ -275,20 +275,15 @@
<goal>jar</goal>
</goals>
<configuration>
<jdkToolchain>
<version>9</version>
</jdkToolchain>
<doclet>nl.talsmasoftware.umldoclet.UMLDoclet</doclet>
<docletArtifact>
<groupId>nl.talsmasoftware</groupId>
<artifactId>umldoclet</artifactId>
<version>${umldoclet.version}</version>
</docletArtifact>
<docencoding>UTF-8</docencoding>
<useStandardDocletOptions>true</useStandardDocletOptions>
<additionalOptions>
<additionalOption>-umlImageFormat SVG</additionalOption>
<additionalOption>-umlImageDirectory images</additionalOption>
<additionalOption>-umlCommand "hide empty fields"</additionalOption>
<additionalOption>-umlCommand "hide empty methods"</additionalOption>
</additionalOptions>
</configuration>
</execution>
</executions>
Expand Down