-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add documentation to Exceptions of Memory module
- Loading branch information
Showing
3 changed files
with
78 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
|
||
# NotEmptyException Class | ||
|
||
## Description | ||
|
||
The `NotEmptyException` class is an exception that is thrown when a value is null or empty. It is part of the `Alis.Core.Aspect.Memory.Exceptions` namespace. | ||
|
||
## Usage | ||
|
||
This exception can be thrown when a value that should not be null or empty is validated. | ||
|
||
```csharp | ||
throw new NotEmptyException("Value cannot be null or empty."); | ||
``` | ||
|
||
## Constructor | ||
|
||
### NotEmptyException(string message) | ||
|
||
This constructor creates a new instance of the `NotEmptyException` class with a specified error message. | ||
|
||
- `message`: The error message that explains the reason for the exception. | ||
|
||
## See Also | ||
|
||
- `Exception`: The base class for this exception. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
|
||
# NotNullException Class | ||
|
||
## Description | ||
|
||
The `NotNullException` class is an exception that is thrown when a value is null. It is part of the `Alis.Core.Aspect.Memory.Exceptions` namespace. | ||
|
||
## Usage | ||
|
||
This exception can be thrown when a value that should not be null is validated. | ||
|
||
```csharp | ||
throw new NotNullException("Value cannot be null."); | ||
``` | ||
|
||
## Constructor | ||
|
||
### NotNullException(string message) | ||
|
||
This constructor creates a new instance of the `NotNullException` class with a specified error message. | ||
|
||
- `message`: The error message that explains the reason for the exception. | ||
|
||
## See Also | ||
|
||
- `Exception`: The base class for this exception. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
|
||
# NotZeroException Class | ||
|
||
## Description | ||
|
||
The `NotZeroException` class is an exception that is thrown when a value is zero. It is part of the `Alis.Core.Aspect.Memory.Exceptions` namespace. | ||
|
||
## Usage | ||
|
||
This exception can be thrown when a value that should not be zero is validated. | ||
|
||
```csharp | ||
throw new NotZeroException("Value cannot be zero."); | ||
``` | ||
|
||
## Constructor | ||
|
||
### NotZeroException(string message) | ||
|
||
This constructor creates a new instance of the `NotZeroException` class with a specified error message. | ||
|
||
- `message`: The error message that explains the reason for the exception. | ||
|
||
## See Also | ||
|
||
- `Exception`: The base class for this exception. |