From c28428cacd2c5df32242a5a5b30ec73e2e32d2a3 Mon Sep 17 00:00:00 2001 From: Brychan Dempsey Date: Sat, 5 Jun 2021 15:57:25 +1200 Subject: [PATCH] Switched to tables --- docs/implementation.md | 21 +++++++++------------ docs/overview.md | 22 ++++++++++------------ docs/system/ECSSystem.md | 29 ++++++++++++++--------------- docs/system/System.md | 16 ++++++---------- docs/system/SystemManager.md | 25 +++++++++---------------- docs/system/dir.md | 9 +++++---- 6 files changed, 53 insertions(+), 69 deletions(-) diff --git a/docs/implementation.md b/docs/implementation.md index 146bc38..be35f42 100644 --- a/docs/implementation.md +++ b/docs/implementation.md @@ -1,9 +1,9 @@ *| [JavaECS](../README.md) | [docs](./overview.md) | implementation[]().md* # Implementation -### Contents -[Steps](#steps) - -[Example](#example) +| **Contents** | +|-| +| [Steps](#steps) | +| [Example](#example) | ## Steps 1. In the application's setup function, create an instance of `ECS`, with a specified maximum number of entity entries. @@ -51,11 +51,8 @@ class ridgidBody{ } ``` - - -### See also: -[entity](./entity/entity.md) - -[component](./component/component.md) - -[system](./system/system.md) +| **See also:** | +|-| +|[Entity](./entity/Entity.md) | +|[Component](./component/Component.md)| +|[System](./system/System.md)| diff --git a/docs/overview.md b/docs/overview.md index b0b06de..ae2b641 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1,16 +1,14 @@ *| [JavaECS](../README.md) | docs* # Overview -### In this folder -[Implementation](./implementation.md) *how to use JavaECS* +| **In this folder** | +|-| +|[Implementation](./implementation.md) *how to use JavaECS*| -### See also: -[Entity](./entity/Entity.md) - -[Component](./component/Component.md) - -[System](./system/System.md) - -[event](./) - -[GameEngine](./) +| **See also:** | +|-| +|[Entity](./entity/Entity.md) | +|[Component](./component/Component.md)| +|[System](./system/System.md)| +|[event](./)| +|[GameEngine](./)| diff --git a/docs/system/ECSSystem.md b/docs/system/ECSSystem.md index 50e6ef3..3781efb 100644 --- a/docs/system/ECSSystem.md +++ b/docs/system/ECSSystem.md @@ -1,27 +1,26 @@ *| [JavaECS](../../README.md) | [docs](../overview.md) | [system](./dir.md) | ECSSystem[]().md* -# System Manager +# ECS System -### In this section -[About](#about) +| **In this Section** | +|-| +| [About](#about) | +| [Implementation](#implementation) | +| [Constructors](#constructors) | +| [Methods](#methods) | +| [Fields](#fields) | -[Implementation](#implementation) - -[Constructors](#constructors) - -[Methods](#methods) - -[Fields](#fields) - -[Examples](#examples) - -[Notes](#notes) ## About -The system manager class controls references to the systems. +The `ECSSystem` class is intended to be extended by a more specific system implementation. + +
## Implementation See [System.md](./System.md#implementation) + +
+ ## Constructors Default constructor ``` java diff --git a/docs/system/System.md b/docs/system/System.md index f7563fd..064f832 100644 --- a/docs/system/System.md +++ b/docs/system/System.md @@ -1,15 +1,11 @@ *| [JavaECS](../../README.md) | [docs](../overview.md) | [system](./dir.md) | System[]().md* # System - -### In this section -[About](#about) - -[Implementation](#implementation) - -[Examples](#examples) - -[Notes](#notes) - +| **In this section** | +|-| +| [About](#about) | +| [Implementation](#implementation)| +| [Examples](#examples)| +| [Notes](#notes) | ## About >A system is a functionality that is executed regularly by the game engine. diff --git a/docs/system/SystemManager.md b/docs/system/SystemManager.md index 4f41e00..e1c59fc 100644 --- a/docs/system/SystemManager.md +++ b/docs/system/SystemManager.md @@ -1,21 +1,14 @@ *| [JavaECS](../../README.md) | [docs](../overview.md) | [system](./dir.md) | SystemManager[]().md* # System Manager - -### In this section -[About](#about) - -[Implementation](#implementation) - -[Constructors](#constructors) - -[Methods](#methods) - -[Fields](#fields) - -[Examples](#examples) - -[Notes](#notes) - +| **In this Section** | +|-| +| [About](#about) | +| [Implementation](#implementation) | +| [Constructors](#constructors) | +| [Methods](#methods) | +| [Fields](#fields) | +| [Examples](#examples)| +| [Notes](#notes)| ## About The system manager class controls references to the systems. diff --git a/docs/system/dir.md b/docs/system/dir.md index 184d1ae..41991a1 100644 --- a/docs/system/dir.md +++ b/docs/system/dir.md @@ -1,6 +1,7 @@ *| [JavaECS](../README.md) | [docs](../overview.md) | system* # Overview -### In this folder -* [ECSSystem.md](./ECSSystem.md) -* [System.md](./System.md) -* [SystemManager.md](./SystemManager.md) \ No newline at end of file +| **In this folder** | +|-| +| [ECSSystem.md](./ECSSystem.md) | +| [System.md](./System.md) | +| [SystemManager.md](./SystemManager.md) | \ No newline at end of file