Skip to content

Commit 2035255

Browse files
committed
fixed javadoc issues
1 parent 28da0b6 commit 2035255

File tree

6 files changed

+18
-17
lines changed

6 files changed

+18
-17
lines changed

pom.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,18 +196,19 @@
196196
<version>3.1.1</version>
197197
<configuration>
198198
<failOnError>false</failOnError>
199-
<additionalparam>-Xdoclint:none</additionalparam>
199+
<!-- <additionalparam>-Xdoclint:none</additionalparam> -->
200200
<additionalOptions>--allow-script-in-comments</additionalOptions>
201201
<quiet>true</quiet>
202202
<!-- does not work with revision property! -->
203203
<ignoreClirr>true</ignoreClirr>
204+
205+
<doclint>all,-html,-syntax</doclint>
204206
<version>false</version>
205207
<nosince>true</nosince>
206208
<author>false</author>
207209
<defaultAuthor>mojo2012</defaultAuthor>
208210
<defaultVersion>1.0</defaultVersion>
209211
<level>public</level>
210-
211212
</configuration>
212213
<executions>
213214
<execution>

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
*
4848
* <script src="https://gist.github.com/3966989.js?file=output.txt"></script>
4949
*
50-
* @see ca.weblite.objc.NSOpenPanelSample
50+
* see NSOpenPanelSample
5151
* @author shannah
5252
* @version $Id: $Id
5353
* @since 1.1
@@ -231,7 +231,7 @@ public Object valueForKey(String key){
231231
* @param selector The
232232
* @return The method object that handles the specified selector (or null
233233
* if none is specified).
234-
* @see RuntimeUtils.sel()
234+
* @see RuntimeUtils#sel(String)
235235
*/
236236
public Method methodForSelector(String selector){
237237
return getMethodMap(this.getClass()).get(selector);
@@ -559,7 +559,7 @@ public void forwardInvocation(long linvocation) {
559559
* to the selector.
560560
*
561561
* @param selector Pointer to the selector to check.
562-
* @see RuntimeUtils.sel()
562+
* @see RuntimeUtils#sel(Peerable)
563563
* @see <a href="http://developer.apple.com/library/ios/#documentation/cocoa/conceptual/objectivec/Chapters/ocSelectors.html">Objective-C selectors reference</a>
564564
* @return a boolean.
565565
*/
@@ -577,7 +577,7 @@ public boolean respondsToSelector(Pointer selector){
577577
* java method in the class that responds to the selector (based on the @Msg
578578
* annotation). Then it will check the parent object to see if it responds
579579
* to the selector.
580-
* @see RuntimeUtils.sel()
580+
* @see RuntimeUtils#sel(Peerable)
581581
* @see <a href="http://developer.apple.com/library/ios/#documentation/cocoa/conceptual/objectivec/Chapters/ocSelectors.html">Objective-C selectors reference</a>
582582
*/
583583
@Override

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ public interface Recipient {
3636
*
3737
* @param invocation The NSInvocation object.
3838
* @see <a href="https://developer.apple.com/library/mac/#documentation/Cocoa/Reference/Foundation/Classes/NSInvocation_Class/Reference/Reference.html#//apple_ref/doc/uid/TP40003671">NSInvocation Class Reference</a>
39-
* @see NSObject.methodSignatureForSelector() For a concrete imlementation.
4039
* @see <a href="https://developer.apple.com/library/mac/#documentation/Cocoa/Reference/Foundation/Classes/NSProxy_Class/Reference/Reference.html#//apple_ref/doc/uid/TP40003719">forwardInvocation: Method reference (from NSProxy)</a>
40+
* @see NSObject#methodSignatureForSelector(long) For a concrete imlementation.
4141
*/
4242
public void forwardInvocation(long invocation);
4343

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ public static Pointer cls(Peerable peer){
104104
*
105105
* @param cls The pointer to the class whose name we wish to retrieve.
106106
* @return The name of the class.
107-
* @see Runtime.class_getName()
107+
* @see Runtime#class_getName(Pointer)
108108
*/
109109
public static String clsName(Pointer cls){
110110
return rt.class_getName(cls);
@@ -115,7 +115,7 @@ public static String clsName(Pointer cls){
115115
* the class pointer. This will return the class name.
116116
*
117117
* @param peer a {@link ca.weblite.objc.Peerable} object.
118-
* @see Runtime.class_getName()
118+
* @see Runtime#class_getName(Pointer)
119119
* @return a {@link java.lang.String} object.
120120
*/
121121
public static String clsName(Peerable peer){
@@ -181,7 +181,7 @@ public static String selName(Peerable peer){
181181
* boolean values, as this will automatically choose the correct underlying
182182
* message function depending on the return type reported by the message
183183
* signature.
184-
* @see msgDouble()
184+
* @see #msgDouble(String, String, Object...)
185185
*/
186186
public static long msg(String cls, String msg, Object... args){
187187
return msg(cls(cls), msg, args);
@@ -204,7 +204,7 @@ public static long msg(String cls, String msg, Object... args){
204204
* boolean values, as this will automatically choose the correct underlying
205205
* message function depending on the return type reported by the message
206206
* signature.
207-
* @see msgDouble()
207+
* @see #msgDouble(String, Pointer, Object...)
208208
*/
209209
public static long msg(String cls, Pointer msg, Object... args){
210210
return msg(cls(cls), msg, args);
@@ -227,7 +227,7 @@ public static long msg(String cls, Pointer msg, Object... args){
227227
* boolean values, as this will automatically choose the correct underlying
228228
* message function depending on the return type reported by the message
229229
* signature.
230-
* @see msgDouble()
230+
* @see #msgDouble(Pointer, String, Object...)
231231
* @param receiver a {@link com.sun.jna.Pointer} object.
232232
*/
233233
public static long msg(Pointer receiver, String msg, Object... args){
@@ -249,7 +249,7 @@ public static long msg(Pointer receiver, String msg, Object... args){
249249
* boolean values, as this will automatically choose the correct underlying
250250
* message function depending on the return type reported by the message
251251
* signature.
252-
* @see msgDouble()
252+
* @see #msgDouble(Pointer, Pointer, Object...)
253253
* @param receiver a {@link com.sun.jna.Pointer} object.
254254
* @param selector a {@link com.sun.jna.Pointer} object.
255255
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ public Object cToJ(Object cVar, String signature, TypeMapping root) {
128128
* specified signature. By default, this will map scalars straight
129129
* across without change. Strings are mapped to NSStrings.
130130
*
131-
* <h5>Example Usage</h5>
131+
* <h1>Example Usage</h1>
132132
* <p>The following is a modified snippet from the NSObject class that shows
133133
* (roughly) how the jToC method is used to take the output of a Java method
134134
* and set the return value in an NSInvocation object to a corresponding

src/main/java/ca/weblite/objc/annotations/Msg.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* the NSSavePanel's -setTitle: message, then the selector would be "setTitle:".
3636
* The -title message, on the other hand would just be "title" (without colon)
3737
* because it takes no parameters.
38-
* @return
38+
* @return the selector name
3939
*/
4040
String selector();
4141

@@ -49,8 +49,8 @@
4949
*
5050
*
5151
*
52-
* <h4>Example Signatures</h4>
53-
* <table>
52+
* <h1>Example Signatures</h1>
53+
* <table summary="Example Signatures">
5454
* <thead>
5555
* <tr>
5656
* <th>Method Type</th>

0 commit comments

Comments
 (0)