Skip to content

Commit

Permalink
docs: add documentation to Exceptions of Memory module
Browse files Browse the repository at this point in the history
  • Loading branch information
pabllopf committed Jan 31, 2024
1 parent a069dea commit 08e43b5
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 0 deletions.
26 changes: 26 additions & 0 deletions 6_Ideation/Memory/src/Exceptions/NotEmptyException.md
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.
26 changes: 26 additions & 0 deletions 6_Ideation/Memory/src/Exceptions/NotNullException.md
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.
26 changes: 26 additions & 0 deletions 6_Ideation/Memory/src/Exceptions/NotZeroException.md
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.

0 comments on commit 08e43b5

Please sign in to comment.