From d0349b140122ca66bcfd8f68d57dc1d31b05bcbe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=99=AA=20hiljusti=20=F0=9F=8E=AE?= Date: Thu, 20 May 2021 14:14:23 -0700 Subject: [PATCH] Update annotation javadocs --- .../java/so/dang/cool/z/annotation/Evil.java | 16 ++++++++-------- .../so/dang/cool/z/annotation/Experimental.java | 9 ++++++--- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/src/main/java/so/dang/cool/z/annotation/Evil.java b/src/main/java/so/dang/cool/z/annotation/Evil.java index 3964d09..a1e8776 100644 --- a/src/main/java/so/dang/cool/z/annotation/Evil.java +++ b/src/main/java/so/dang/cool/z/annotation/Evil.java @@ -1,12 +1,12 @@ package so.dang.cool.z.annotation; /** - * WARNING!! You are using evil code. - * + * WARNING!! You are using evil code. + *
* In the battle between good and evil, always strive for a heroic path. All - * code marked as @Evil is evil. It can destroy your assumptions and run amok - * in ways that are hard to anticipate. - * + * code marked as {@code @Evil} is evil. It can destroy your assumptions and + * run amok in ways that are hard to anticipate. + *
* There are only two reasons to use Evil code: * *
    @@ -19,13 +19,13 @@ * and determination, you might even be able to completely tame evil code. * You may even make it a redeemed companion... But remember that redemption * comes at a cost. - * + *
    * If you're attempting to control evil, you might need to explain how you're * doing it. - * + *
    * If you're reviewing code that uses evil code, it's a code smell and it's * reasonable to ask for explanations. - * + *
    * Categories of evil: * *