Skip to content

Commit fee85d5

Browse files
author
Zihlu Wang
committed
docs(devkit-core): Optimised javadoc.
1 parent 007d192 commit fee85d5

File tree

1 file changed

+3
-11
lines changed

1 file changed

+3
-11
lines changed

devkit-core/src/main/java/cn/org/codecrafters/devkit/core/exceptions/NotImplementedException.java

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,31 +18,23 @@
1818
package cn.org.codecrafters.devkit.core.exceptions;
1919

2020
/**
21-
* NotImplementedException - Custom Runtime Exception
22-
* <p>
2321
* The {@code NotImplementedException} class is a custom runtime exception
2422
* that represents a situation where a particular method or functionality is
25-
* not implemented or is currently unavailable in the codebase. It extends the
26-
* standard {@code RuntimeException} class, making it an unchecked exception.
27-
*
23+
* not implemented or is currently unavailable in the codebase.
2824
* <p>
2925
* This exception is typically thrown when developers need to indicate that a
3026
* specific part of the code is incomplete or requires further implementation.
3127
* It serves as a placeholder to highlight unfinished sections of the
3228
* application during development and testing phases.
33-
*
3429
* <p>
3530
* Usage Example:
36-
*
3731
* <pre>
3832
* public void someMethod() {
3933
* // Some code...
4034
* throw new NotImplementedException("""
41-
* This feature will be implemented in a future release.
42-
* """);
35+
* This feature will be implemented in a future release.""");
4336
* }
4437
* </pre>
45-
*
4638
* <b>Contact</b>
4739
* <ul>
4840
* <li>
@@ -55,7 +47,7 @@
5547
* </ul>
5648
*
5749
* @author Zihlu Wang
58-
* @version 1.0.0
50+
* @version 1.1.0
5951
* @see RuntimeException
6052
* @since 1.0.0
6153
*/

0 commit comments

Comments
 (0)