Skip to content

Commit f198546

Browse files
author
Matthias Fuchs
committed
fixed more javadoc
1 parent 2a4d1a0 commit f198546

23 files changed

+52
-17
lines changed

pom.xml

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -194,14 +194,29 @@
194194
<groupId>org.apache.maven.plugins</groupId>
195195
<artifactId>maven-javadoc-plugin</artifactId>
196196
<version>3.1.1</version>
197-
<executions>
198-
<execution>
199-
<id>attach-javadocs</id>
200-
<goals>
201-
<goal>jar</goal>
202-
</goals>
203-
</execution>
204-
</executions>
197+
<configuration>
198+
<failOnError>false</failOnError>
199+
<additionalparam>-Xdoclint:none</additionalparam>
200+
<additionalOptions>--allow-script-in-comments</additionalOptions>
201+
<quiet>true</quiet>
202+
<!-- does not work with revision property! -->
203+
<ignoreClirr>true</ignoreClirr>
204+
<version>false</version>
205+
<nosince>true</nosince>
206+
<author>false</author>
207+
<defaultAuthor>mojo2012</defaultAuthor>
208+
<defaultVersion>1.0</defaultVersion>
209+
<level>public</level>
210+
211+
</configuration>
212+
<executions>
213+
<execution>
214+
<id>attach-javadocs</id>
215+
<goals>
216+
<goal>jar</goal>
217+
</goals>
218+
</execution>
219+
</executions>
205220
</plugin>
206221
<plugin>
207222
<groupId>org.apache.maven.plugins</groupId>

src/main/java/ca/weblite/nativeutils/NativeUtils.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* @see http://frommyplayground.com/how-to-load-native-jni-library-from-jar
1414
* @author Adam Heirnich <[email protected]>, http://www.adamh.cz
1515
* @version $Id: $Id
16+
* @since 1.1
1617
*/
1718
public class NativeUtils {
1819

@@ -38,11 +39,12 @@ public static void loadLibraryFromJar(String path) throws IOException {
3839
* The file from JAR is copied into system temporary directory and then loaded. The temporary file is deleted after exiting.
3940
* Method uses String as filename because the pathname is "abstract", not system-dependent.
4041
*
41-
* @throws java.io.IOException If temporary file creation or read/write operation fails
42+
* @throws java.lang.IllegalArgumentException If the path is not absolute or if the filename is shorter than three characters (restriction of {@see File#createTempFile(java.lang.String, java.lang.String)}).
4243
* @throws java.lang.IllegalArgumentException If the path is not absolute or if the filename is shorter than three characters (restriction of {@see File#createTempFile(java.lang.String, java.lang.String)}).
4344
* @throws java.lang.IllegalArgumentException If the path is not absolute or if the filename is shorter than three characters (restriction of {@see File#createTempFile(java.lang.String, java.lang.String)}).
4445
* @param path a {@link java.lang.String} object.
4546
* @param source a {@link java.lang.Class} object.
47+
* @throws java.io.IOException if any.
4648
*/
4749
public static void loadLibraryFromJar(String path, Class source) throws IOException {
4850

src/main/java/ca/weblite/objc/Client.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
*
3232
* @author shannah
3333
* @version $Id: $Id
34+
* @since 1.1
3435
*/
3536
public class Client {
3637

src/main/java/ca/weblite/objc/Constants.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
*
1111
* @author shannah
1212
* @version $Id: $Id
13+
* @since 1.1
1314
*/
1415
public interface Constants {
1516
/** Constant <code>VERSION="1.0"</code> */

src/main/java/ca/weblite/objc/Message.java

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
/*
2-
* To change this template, choose Tools | Templates
3-
* and open the template in the editor.
4-
*/
51
package ca.weblite.objc;
62

73
import com.sun.jna.Pointer;
@@ -12,11 +8,12 @@
128
* A structure the encapsulates a message. This is an optional alternative
139
* way of sending messages to the Objective-C runtime.
1410
*
15-
* @see Client.send(Message...)
16-
* @see RuntimeUtils.msg(Message...)
17-
* @see Proxy.send(Message...)
11+
* @see Client#send(Message...)
12+
* @see RuntimeUtils#msg(Message...)
13+
* @see Proxy#send(Message...)
1814
* @author shannah
1915
* @version $Id: $Id
16+
* @since 1.1
2017
*/
2118
public class Message {
2219

src/main/java/ca/weblite/objc/NSObject.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,10 @@
5151
*
5252
* <script src="https://gist.github.com/3966989.js?file=output.txt"></script>
5353
*
54-
* @see NSOpenPanelSample
54+
* @see ca.weblite.objc.NSOpenPanelSample
5555
* @author shannah
5656
* @version $Id: $Id
57+
* @since 1.1
5758
*/
5859
public class NSObject extends Proxy implements PeerableRecipient {
5960
private static final Logger LOG = Logger.getLogger("NSObject");
@@ -177,6 +178,7 @@ public NSObject(Client c, Pointer peer){
177178
* Initializes this object and registers it with the Objective-C runtime.
178179
*
179180
* @return Self for chaining.
181+
* @param parent a {@link com.sun.jna.Pointer} object.
180182
*/
181183
public NSObject init(Pointer parent){
182184
this.cls = Runtime.INSTANCE.object_getClass(parent);

src/main/java/ca/weblite/objc/NativeLibLoader.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
*
1212
* @author shannah
1313
* @version $Id: $Id
14+
* @since 1.1
1415
*/
1516
public class NativeLibLoader implements Constants {
1617
private boolean loaded;

src/main/java/ca/weblite/objc/Peerable.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
*
1212
* @author shannah
1313
* @version $Id: $Id
14+
* @since 1.1
1415
*/
1516
public interface Peerable {
1617
/**

src/main/java/ca/weblite/objc/PeerableRecipient.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
*
1111
* @author shannah
1212
* @version $Id: $Id
13+
* @since 1.1
1314
*/
1415
public interface PeerableRecipient extends Peerable, Recipient {
1516

src/main/java/ca/weblite/objc/Proxy.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
* @see <a href="https://github.com/twall/jna">JavaNativeAccess On GitHub</a>
3131
* @author shannah
3232
* @version $Id: $Id
33+
* @since 1.1
3334
*/
3435
public class Proxy implements Peerable {
3536

0 commit comments

Comments
 (0)