Skip to content

Commit

Permalink
fix invalid Javadoc
Browse files Browse the repository at this point in the history
Seems like IntelliJ understands this Javadoc, but the javadoc tool does not. I have changed it back to the usual syntax we use (even though it is really annoying / ugly, in particular with @literal taking up an extra space).

Signed-off-by: Peter Gafert <peter.gafert@tngtech.com>
  • Loading branch information
codecholeric committed Feb 21, 2021
1 parent 192bc02 commit 937a9cc
Showing 1 changed file with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,33 +21,33 @@

/**
* Includes all {@code @ArchTest} annotated members of another class into this ArchUnit test. For example
* <pre>{@code
* <pre><code>
* class MyArchRuleSuite1 {
* @ArchTest
* {@literal @}ArchTest
* static final ArchRule suite1Rule1 = classes()...
*
* @ArchTest
* {@literal @}ArchTest
* static void suite1Rule2(JavaClasses classes) {
* // ...
* }
* }
*
* class MyArchRuleSuite2 {
* @ArchTest
* {@literal @}ArchTest
* static final ArchRule suite2Rule1 = classes()...
* }
*
* @AnalyzeClasses(..)
*{@literal @}AnalyzeClasses(..)
* class MyArchitectureTest {
* // includes all @ArchTest members from MyArchRuleSuite1
* @ArchTest
* // includes all{@literal @}ArchTest members from MyArchRuleSuite1
* {@literal @}ArchTest
* static final ArchTests includedRules1 = ArchTests.in(MyArchRuleSuite1.class);
*
* // includes all @ArchTest members from MyArchRuleSuite2
* @ArchTest
* // includes all{@literal @}ArchTest members from MyArchRuleSuite2
* {@literal @}ArchTest
* static final ArchTests includedRules2 = ArchTests.in(MyArchRuleSuite2.class);
* }
* }</pre>
* </code></pre>
*/
public final class ArchTests {
private final Class<?> definitionLocation;
Expand Down

0 comments on commit 937a9cc

Please sign in to comment.