Skip to content

Commit

Permalink
Update annotation javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
booniepepper committed May 20, 2021
1 parent 34e23d6 commit d0349b1
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 11 deletions.
16 changes: 8 additions & 8 deletions src/main/java/so/dang/cool/z/annotation/Evil.java
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package so.dang.cool.z.annotation;

/**
* WARNING!! You are using evil code.
*
* <b>WARNING!!</b> You are using evil code.
* <br>
* 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.
* <br>
* There are only two reasons to use Evil code:
*
* <ol>
Expand All @@ -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.
*
* <br>
* If you're attempting to control evil, you might need to explain how you're
* doing it.
*
* <br>
* If you're reviewing code that uses evil code, it's a code smell and it's
* reasonable to ask for explanations.
*
* <br>
* Categories of evil:
*
* <ul>
Expand Down
9 changes: 6 additions & 3 deletions src/main/java/so/dang/cool/z/annotation/Experimental.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
package so.dang.cool.z.annotation;

public @interface Experimental {

}
/**
* <b>WARNING!!</b> You are using experimental code.
* <br>
* This is not yet stable, and may change in future versions.
*/
public @interface Experimental { }

0 comments on commit d0349b1

Please sign in to comment.