diff options
author | Jerry James <loganjerry@gmail.com> | 2020-09-14 08:27:01 -0600 |
---|---|---|
committer | Jerry James <loganjerry@gmail.com> | 2020-09-14 08:27:01 -0600 |
commit | de14ca22d72be35e59ce370ef0edf8626db6cd82 (patch) | |
tree | 746054ba7809fd6c7990a364dff0050a3fc7012e /bridge | |
parent | f8f117808bef16efd520803636c6841332e83c49 (diff) | |
download | aspectj-de14ca22d72be35e59ce370ef0edf8626db6cd82.tar.gz aspectj-de14ca22d72be35e59ce370ef0edf8626db6cd82.zip |
Fix misplaced or incorrect javadoc tags
Diffstat (limited to 'bridge')
-rw-r--r-- | bridge/src/main/java/org/aspectj/bridge/IMessage.java | 13 | ||||
-rw-r--r-- | bridge/src/main/java/org/aspectj/bridge/MessageUtil.java | 21 |
2 files changed, 24 insertions, 10 deletions
diff --git a/bridge/src/main/java/org/aspectj/bridge/IMessage.java b/bridge/src/main/java/org/aspectj/bridge/IMessage.java index 694da8af0..256db87ac 100644 --- a/bridge/src/main/java/org/aspectj/bridge/IMessage.java +++ b/bridge/src/main/java/org/aspectj/bridge/IMessage.java @@ -146,5 +146,18 @@ public interface IMessage { * being based on a subtype of a defining type. * @see <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=41952">AspectJ bug 41952</a> */ + /** + * Return a List of <code>ISourceLocation</code> instances that indicate additional source locations relevent to this message as + * specified by the message creator. The list should not include the primary source location associated with the message + * which can be obtained from <code>getSourceLocation()<code>. + * <p> + * An example of using extra locations would be in a warning message that + * flags all shadow locations that will go unmatched due to a pointcut definition + * being based on a subtype of a defining type. + * </p> + * + * @return a list of additional source locations + * @see <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=41952">AspectJ bug 41952</a> + */ List<ISourceLocation> getExtraSourceLocations(); } diff --git a/bridge/src/main/java/org/aspectj/bridge/MessageUtil.java b/bridge/src/main/java/org/aspectj/bridge/MessageUtil.java index 0385ba696..3d9d8c69d 100644 --- a/bridge/src/main/java/org/aspectj/bridge/MessageUtil.java +++ b/bridge/src/main/java/org/aspectj/bridge/MessageUtil.java @@ -260,7 +260,7 @@ public class MessageUtil { /** * Print all message to the print stream, starting each on a new line, with a prefix. * - * @param messageHolder + * @param holder * @param out * @see #print(PrintStream, String, IMessageHolder, IMessageRenderer, IMessageHandler) */ @@ -271,7 +271,7 @@ public class MessageUtil { /** * Print all message to the print stream, starting each on a new line, with a prefix and using a renderer. * - * @param messageHolder + * @param holder * @param out * @param renderer IMessageRender to render result - use MESSAGE_LINE if null * @see #print(PrintStream, String, IMessageHolder, IMessageRenderer, IMessageHandler) @@ -292,7 +292,8 @@ public class MessageUtil { * are free to render multi-line output. * * @param out the PrintStream sink - return silently if null - * @param messageHolder the IMessageHolder with the messages to print + * @param holder the IMessageHolder with the messages to print + * @param prefix the prefix for each line * @param renderer IMessageRender to render result - use MESSAGE_ALL if null * @param selector IMessageHandler to select messages to render - if null, do all non-null */ @@ -1038,8 +1039,8 @@ public class MessageUtil { /** * Handle all messages in the second handler using the first * - * @param handler the IMessageHandler sink for all messages in source - * @param holder the IMessageHolder source for all messages to handle + * @param sink the IMessageHandler sink for all messages in source + * @param source the IMessageHolder source for all messages to handle * @param fastFail if true, stop on first failure * @return false if any sink.handleMessage(..) failed */ @@ -1050,8 +1051,8 @@ public class MessageUtil { /** * Handle messages in the second handler using the first * - * @param handler the IMessageHandler sink for all messages in source - * @param holder the IMessageHolder source for all messages to handle + * @param sink the IMessageHandler sink for all messages in source + * @param source the IMessageHolder source for all messages to handle * @param kind the IMessage.Kind to select, if not null * @param orGreater if true, also accept greater kinds * @param fastFail if true, stop on first failure @@ -1068,8 +1069,8 @@ public class MessageUtil { * Handle messages in the second handler using the first if they are NOT of this kind (optionally, or greater). If you pass null * as the kind, then all messages are ignored and this returns true. * - * @param handler the IMessageHandler sink for all messages in source - * @param holder the IMessageHolder source for all messages to handle + * @param sink the IMessageHandler sink for all messages in source + * @param source the IMessageHolder source for all messages to handle * @param kind the IMessage.Kind to reject, if not null * @param orGreater if true, also reject greater kinds * @param fastFail if true, stop on first failure @@ -1089,7 +1090,7 @@ public class MessageUtil { /** * Handle messages in the sink. * - * @param handler the IMessageHandler sink for all messages in source + * @param sink the IMessageHandler sink for all messages in source * @param sources the IMessage[] messages to handle * @param fastFail if true, stop on first failure * @return false if any sink.handleMessage(..) failed |