Skip to content

Commit

Permalink
Redirect documentation link to the new location
Browse files Browse the repository at this point in the history
  • Loading branch information
Emik03 committed Oct 12, 2024
1 parent 0da4cfd commit 3d91929
Show file tree
Hide file tree
Showing 16 changed files with 42 additions and 18 deletions.
1 change: 0 additions & 1 deletion apidocs/wawa.Modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,5 @@

| Name | Summary |
|------|---------|
| [Emik\.Morsels](./wawa.Modules/Emik.Morsels.md) | |
| [wawa\.Modules](./wawa.Modules/wawa.Modules.md) | |

1 change: 0 additions & 1 deletion apidocs/wawa.Recall.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,4 @@
| Name | Summary |
|------|---------|
| [wawa\.Recall](./wawa.Recall/wawa.Recall.md) | |
| [wawa\.Recall\.Internals](./wawa.Recall/wawa.Recall.Internals.md) | |

5 changes: 3 additions & 2 deletions apidocs/wawa.Schemas.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# wawa\.Schemas Assembly


Provides a simple fluent builder API for building the [TweaksEditorSettings](./wawa.Schemas/wawa.Schemas/TweaksEditorSettings.md)
schema object that Tweaks can use to format your mod settings\.

## Namespaces

| Name | Summary |
|------|---------|
| [wawa\.Schemas](./wawa.Schemas/wawa.Schemas.md) | |
| [wawa\.Schemas](./wawa.Schemas/wawa.Schemas.md) | Contains the core functionality of the library\. |
| [wawa\.Schemas\.Fluent](./wawa.Schemas/wawa.Schemas.Fluent.md) | |

2 changes: 1 addition & 1 deletion apidocs/wawa.Schemas/wawa.Schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

assembly: [wawa\.Schemas](../wawa.Schemas.md)


Contains the core functionality of the library\.

```csharp
namespace wawa.Schemas;
Expand Down
2 changes: 1 addition & 1 deletion wawa.DDL/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Implements the [DDL pattern](https://github.com/Emik03/.DDL#chapter-23-the-ddl-pattern) to allow direct access to common
in-game values that are normally annoying to obtain.

### [Documentation](https://github.com/Emik03/wawa/blob/main/wawa.DDL/Documentation/wawa.DDL.md)
### [Documentation](https://github.com/Emik03/wawa/blob/main/apidocs/wawa.DDL/wawa.DDL.md)

---

Expand Down
2 changes: 1 addition & 1 deletion wawa.Extensions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Implements convenience extension methods for `KMFramework` types, as well as fixes for broken/buggy ones.

### [Documentation](https://github.com/Emik03/wawa/blob/main/wawa.Extensions/Documentation/wawa.Extensions.md)
### [Documentation](https://github.com/Emik03/wawa/blob/main/apidocs/wawa.Extensions/wawa.Extensions.md)

---

Expand Down
2 changes: 1 addition & 1 deletion wawa.IO/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Adds types for KTaNE-related IO operations.

### [Documentation](https://github.com/Emik03/wawa/blob/main/wawa.IO/Documentation/wawa.IO.md)
### [Documentation](https://github.com/Emik03/wawa/blob/main/apidocs/wawa.IO/wawa.IO.md)

---

Expand Down
2 changes: 1 addition & 1 deletion wawa.Modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Adds a base type for modules.

### [Documentation](https://github.com/Emik03/wawa/blob/main/wawa.Modules/Documentation/wawa.Modules.md)
### [Documentation](https://github.com/Emik03/wawa/blob/main/apidocs/wawa.Modules/wawa.Modules.md)

---

Expand Down
2 changes: 1 addition & 1 deletion wawa.Optionals/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Defines the `Maybe<T>` type, which is used throughout these libraries to represe
All returned values from these libraries can be assumed to be always non-null, as a fallback value, or this type is used
to explicitly mark optional values.

### [Documentation](https://github.com/Emik03/wawa/blob/main/wawa.Optionals/Documentation/wawa.Optionals.md)
### [Documentation](https://github.com/Emik03/wawa/blob/main/apidocs/wawa.Optionals/wawa.Optionals.md)

---

Expand Down
2 changes: 1 addition & 1 deletion wawa.Recall/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Allows for hooking and unhooking of module controllers and its selectables. Supports hooking vanilla and modded components under the same API.

### [Documentation](https://github.com/Emik03/wawa/blob/main/wawa.Recall/Documentation/wawa.Recall.md)
### [Documentation](https://github.com/Emik03/wawa/blob/main/apidocs/wawa.Recall/wawa.Recall.md)

---

Expand Down
4 changes: 2 additions & 2 deletions wawa.Recall/Source/Internals/Globals.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ static class Globals
{
/// <summary>Contains cached elements.</summary>
/// <typeparam name="T">The type of item.</typeparam>
public static class DelegateLot<T>
internal static class DelegateLot<T>
where T : Delegate
{
/// <summary>Gets the function that returns the parameter.</summary>
Expand All @@ -15,7 +15,7 @@ public static class DelegateLot<T>

/// <summary>Contains cached elements.</summary>
/// <typeparam name="T">The type of item.</typeparam>
public static class Lot<T>
internal static class Lot<T>
{
/// <summary>Gets the function that returns the parameter.</summary>
public static Func<T, T> Id => x => x;
Expand Down
2 changes: 1 addition & 1 deletion wawa.Schemas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Provides a simple fluent builder API for building the `TweaksEditorSettings` schema object that Tweaks can use to format your mod settings.

### [Documentation](https://github.com/Emik03/wawa/blob/main/wawa.Schemas/Documentation/wawa.Schemas.md)
### [Documentation](https://github.com/Emik03/wawa/blob/main/apidocs/wawa.Schemas.md)

---

Expand Down
24 changes: 24 additions & 0 deletions wawa.Schemas/Source/Internals/NamespaceDoc.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// SPDX-License-Identifier: MPL-2.0
namespace wawa.Schemas
{
/// <summary>
/// Provides a simple fluent builder API for building the <see cref="TweaksEditorSettings"/>
/// schema object that Tweaks can use to format your mod settings.
/// </summary>
[UsedImplicitly]
struct AssemblyDoc;
}

namespace wawa.Schemas
{
/// <summary>Contains the core functionality of the library.</summary>
[UsedImplicitly]
struct NamespaceDoc;
}

namespace wawa.Schemas.Domains
{
/// <summary>Contains objects returned by the fluent builder APIs.</summary>
[UsedImplicitly]
struct NamespaceDoc;
}
2 changes: 1 addition & 1 deletion wawa.TwitchPlays/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Adds an extensive system for creating Twitch Plays components that are attached to modded modules.

### [Documentation](https://github.com/Emik03/wawa/blob/main/wawa.TwitchPlays/Documentation/index.md)
### [Documentation](https://github.com/Emik03/wawa/blob/main/apidocs/wawa.TwitchPlays.md)

---

Expand Down
5 changes: 3 additions & 2 deletions wawa.TwitchPlays/Source/Internals/NamespaceDoc.cs
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
// SPDX-License-Identifier: MPL-2.0
#pragma warning disable 3005, MA0048, SA1300, SA1403
namespace wawa.TwitchPlays
{
/// <summary>Adds an extensive system for creating Twitch Plays components that are attached to modded modules.</summary>
/// <summary>
/// Adds an extensive system for creating Twitch Plays components that are attached to modded modules.
/// </summary>
[UsedImplicitly]
struct AssemblyDoc;
}
Expand Down
2 changes: 1 addition & 1 deletion wawa.Unity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Defines the `CachedBehavior` type, which provides a simple API for caching Unity API calls such as [`GetComponent`](https://docs.unity3d.com/2017.4/Documentation/ScriptReference/Component.GetComponent.html).

### [Documentation](https://github.com/Emik03/wawa/blob/main/wawa.Unity/Documentation/wawa.Unity.md)
### [Documentation](https://github.com/Emik03/wawa/blob/main/apidocs/wawa.Unity/wawa.Unity.md)

---

Expand Down

0 comments on commit 3d91929

Please sign in to comment.