docs: formating documentation

This commit is contained in:
Dylan R. E. Moonfire 2022-06-06 09:33:03 -05:00
parent 18264b4b2b
commit 53d36cd8c2
3 changed files with 30 additions and 30 deletions

View file

@ -4,9 +4,9 @@ This assembly contains the primary system for reading and writing from the disk,
along with various processes to manipulate paths. It contains three primary
components:
- File System I/O
- Path Normalization
- Disk-Based Content
- File System I/O
- Path Normalization
- Disk-Based Content
## File System I/O

View file

@ -48,34 +48,34 @@ Assert.Equal(2, newEntity.Count);
The basic operations for entity components are:
- `Add<TType>(component)`: Adds a component as the given type. If there is
already a component there, an exception will be thrown.
- `Add(component)`: As `Add<TType>(component)` but the `TType` is the same as
`component.GetType()`.
- `Remove<TType>()`: Removes any component of the given type, if exists. If
there is no such component, then nothing happens.
- `Remove(component)`: Same as `Remove<TType>` with the component given
determining the `TType`.
- `Set<TType>(component)`: Adds or updates a component of the given type.
- `Set(component)`: Same as `Set<TType>` with the component given determining
the `TType`.
- `Copy()`: Creates a copy of the entity and assigns it a new identifier.
- `ExactCopy()`: Creates a copy of the entity with the same identifier.
- `Add<TType>(component)`: Adds a component as the given type. If there is
already a component there, an exception will be thrown.
- `Add(component)`: As `Add<TType>(component)` but the `TType` is the same as
`component.GetType()`.
- `Remove<TType>()`: Removes any component of the given type, if exists. If
there is no such component, then nothing happens.
- `Remove(component)`: Same as `Remove<TType>` with the component given
determining the `TType`.
- `Set<TType>(component)`: Adds or updates a component of the given type.
- `Set(component)`: Same as `Set<TType>` with the component given determining
the `TType`.
- `Copy()`: Creates a copy of the entity and assigns it a new identifier.
- `ExactCopy()`: Creates a copy of the entity with the same identifier.
As above, all of these return a new entity (or the same one if no change is made
to the entity).
### Query Components
- `bool Has<TType>()`: Returns a value indicating whether the entity has the
given component type.
- `TType Get<TType>()`: Returns the value of the registered component. If there
is no such object, this will throw an exception.
- `TType? GetOptional<TType>()`: Returns the value of the registered component.
If there is no such object, this will return the default value.
- `bool TryGet<TType>(out TType component)`: Attempt to get the component. If it
cannot be retrieved, then this will return `false` and `component` is
undefined.
- `bool Has<TType>()`: Returns a value indicating whether the entity has the
given component type.
- `TType Get<TType>()`: Returns the value of the registered component. If there
is no such object, this will throw an exception.
- `TType? GetOptional<TType>()`: Returns the value of the registered component.
If there is no such object, this will return the default value.
- `bool TryGet<TType>(out TType component)`: Attempt to get the component. If it
cannot be retrieved, then this will return `false` and `component` is
undefined.
## Collections

View file

@ -2,8 +2,8 @@
## Immediate
- Switch the various operations to be async
- ReadFiles
- WriteFiles
- Implement mime type determination
- Implement a convert to text content based on mime type
- Switch the various operations to be async
- ReadFiles
- WriteFiles
- Implement mime type determination
- Implement a convert to text content based on mime type