onixbyte/onixbyte-bom
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: added docs

Browse Source
This commit is contained in:
zihluwang
2025-01-18 14:06:13 +08:00
parent 566a960c14
commit a85c562b66
22 changed files with 357 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files
devkit-core/src/main/java/com/onixbyte/devkit/core/exceptions/NotImplementedException.java
+10 -8
View File
@@ -18,12 +18,13 @@
package com.onixbyte.devkit.core.exceptions;
/**
* The {@code NotImplementedException} class is a custom runtime exception that represents a situation where a
* particular method or functionality is not implemented or is currently unavailable in the codebase.
* The {@code NotImplementedException} class is a custom runtime exception that represents a
* situation where a particular method or functionality is not implemented or is currently
* unavailable in the codebase.
* <p>
* This exception is typically thrown when developers need to indicate that a specific part of the code is incomplete
* or requires further implementation. It serves as a placeholder to highlight unfinished sections of the application
* during development and testing phases.
* This exception is typically thrown when developers need to indicate that a specific part of the
* code is incomplete or requires further implementation. It serves as a placeholder to highlight
* unfinished sections of the application during development and testing phases.
* <p>
* Usage Example:
* <pre>
@@ -57,7 +58,8 @@ public class NotImplementedException extends RuntimeException {
}
/**
* Creates a new {@code NotImplementedException} with the specified error message and a cause for this exception.
* Creates a new {@code NotImplementedException} with the specified error message and a cause
* for this exception.
*
* @param message the error message associated with this exception
* @param cause the cause of this exception
@@ -76,8 +78,8 @@ public class NotImplementedException extends RuntimeException {
}
/**
* Creates a new {@code NotImplementedException} with the specified error message, cause, suppression flag, and
* stack trace writable flag.
* Creates a new {@code NotImplementedException} with the specified error message, cause,
* suppression flag, and stack trace writable flag.
*
* @param message the error message associated with this
* exception
devkit-core/src/main/resources/logback.xml
+4 -2
View File
@@ -17,8 +17,10 @@
-->
<configuration>
<property name="COLOURFUL_OUTPUT" value="%black(%date{'dd MMM, yyyy HH:mm:ss', Asia/Hong_Kong, en-UK}) %highlight(%-5level) %black(---) %black([%10.10t]) %cyan(%-20.20logger{20}) %black(:) %msg%n"/>
<property name="STANDARD_OUTPUT" value="%date{'dd MMM, yyyy HH:mm:ss', Asia/Hong_Kong, en-UK} %-5level %black(---) [%10.10t] %-20.20logger{20} : %msg%n"/>
<property name="COLOURFUL_OUTPUT"
value="%black(%date{'dd MMM, yyyy HH:mm:ss', Asia/Hong_Kong, en-UK}) %highlight(%-5level) %black(---) %black([%10.10t]) %cyan(%-20.20logger{20}) %black(:) %msg%n"/>
<property name="STANDARD_OUTPUT"
value="%date{'dd MMM, yyyy HH:mm:ss', Asia/Hong_Kong, en-UK} %-5level %black(---) [%10.10t] %-20.20logger{20} : %msg%n"/>
<statusListener class="ch.qos.logback.core.status.NopStatusListener" />
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">