From 3d9192906377b8143e528cf554839757a19a7238 Mon Sep 17 00:00:00 2001 From: Emik Date: Sun, 13 Oct 2024 01:26:09 +0200 Subject: [PATCH] Redirect documentation link to the new location --- apidocs/wawa.Modules.md | 1 - apidocs/wawa.Recall.md | 1 - apidocs/wawa.Schemas.md | 5 ++-- apidocs/wawa.Schemas/wawa.Schemas.md | 2 +- wawa.DDL/README.md | 2 +- wawa.Extensions/README.md | 2 +- wawa.IO/README.md | 2 +- wawa.Modules/README.md | 2 +- wawa.Optionals/README.md | 2 +- wawa.Recall/README.md | 2 +- wawa.Recall/Source/Internals/Globals.cs | 4 ++-- wawa.Schemas/README.md | 2 +- wawa.Schemas/Source/Internals/NamespaceDoc.cs | 24 +++++++++++++++++++ wawa.TwitchPlays/README.md | 2 +- .../Source/Internals/NamespaceDoc.cs | 5 ++-- wawa.Unity/README.md | 2 +- 16 files changed, 42 insertions(+), 18 deletions(-) create mode 100755 wawa.Schemas/Source/Internals/NamespaceDoc.cs diff --git a/apidocs/wawa.Modules.md b/apidocs/wawa.Modules.md index efc32ef..6ab8511 100755 --- a/apidocs/wawa.Modules.md +++ b/apidocs/wawa.Modules.md @@ -6,6 +6,5 @@ | Name | Summary | |------|---------| -| [Emik\.Morsels](./wawa.Modules/Emik.Morsels.md) | | | [wawa\.Modules](./wawa.Modules/wawa.Modules.md) | | diff --git a/apidocs/wawa.Recall.md b/apidocs/wawa.Recall.md index dbac05a..3ef31df 100755 --- a/apidocs/wawa.Recall.md +++ b/apidocs/wawa.Recall.md @@ -7,5 +7,4 @@ | Name | Summary | |------|---------| | [wawa\.Recall](./wawa.Recall/wawa.Recall.md) | | -| [wawa\.Recall\.Internals](./wawa.Recall/wawa.Recall.Internals.md) | | diff --git a/apidocs/wawa.Schemas.md b/apidocs/wawa.Schemas.md index 404098f..0cdb32b 100755 --- a/apidocs/wawa.Schemas.md +++ b/apidocs/wawa.Schemas.md @@ -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) | | diff --git a/apidocs/wawa.Schemas/wawa.Schemas.md b/apidocs/wawa.Schemas/wawa.Schemas.md index af29781..a3ffc8c 100755 --- a/apidocs/wawa.Schemas/wawa.Schemas.md +++ b/apidocs/wawa.Schemas/wawa.Schemas.md @@ -2,7 +2,7 @@ assembly: [wawa\.Schemas](../wawa.Schemas.md) - +Contains the core functionality of the library\. ```csharp namespace wawa.Schemas; diff --git a/wawa.DDL/README.md b/wawa.DDL/README.md index 7188eb7..4d32919 100755 --- a/wawa.DDL/README.md +++ b/wawa.DDL/README.md @@ -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) --- diff --git a/wawa.Extensions/README.md b/wawa.Extensions/README.md index cc2766c..b9626be 100755 --- a/wawa.Extensions/README.md +++ b/wawa.Extensions/README.md @@ -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) --- diff --git a/wawa.IO/README.md b/wawa.IO/README.md index f345534..d296d18 100755 --- a/wawa.IO/README.md +++ b/wawa.IO/README.md @@ -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) --- diff --git a/wawa.Modules/README.md b/wawa.Modules/README.md index 9a7fd6a..906e8d7 100755 --- a/wawa.Modules/README.md +++ b/wawa.Modules/README.md @@ -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) --- diff --git a/wawa.Optionals/README.md b/wawa.Optionals/README.md index b046fa7..d15eb21 100755 --- a/wawa.Optionals/README.md +++ b/wawa.Optionals/README.md @@ -5,7 +5,7 @@ Defines the `Maybe` 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) --- diff --git a/wawa.Recall/README.md b/wawa.Recall/README.md index e39df0d..f0ccf8d 100755 --- a/wawa.Recall/README.md +++ b/wawa.Recall/README.md @@ -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) --- diff --git a/wawa.Recall/Source/Internals/Globals.cs b/wawa.Recall/Source/Internals/Globals.cs index d005f35..07d4108 100755 --- a/wawa.Recall/Source/Internals/Globals.cs +++ b/wawa.Recall/Source/Internals/Globals.cs @@ -6,7 +6,7 @@ static class Globals { /// Contains cached elements. /// The type of item. - public static class DelegateLot + internal static class DelegateLot where T : Delegate { /// Gets the function that returns the parameter. @@ -15,7 +15,7 @@ public static class DelegateLot /// Contains cached elements. /// The type of item. - public static class Lot + internal static class Lot { /// Gets the function that returns the parameter. public static Func Id => x => x; diff --git a/wawa.Schemas/README.md b/wawa.Schemas/README.md index d9e2558..9fe6d62 100755 --- a/wawa.Schemas/README.md +++ b/wawa.Schemas/README.md @@ -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) --- diff --git a/wawa.Schemas/Source/Internals/NamespaceDoc.cs b/wawa.Schemas/Source/Internals/NamespaceDoc.cs new file mode 100755 index 0000000..664943b --- /dev/null +++ b/wawa.Schemas/Source/Internals/NamespaceDoc.cs @@ -0,0 +1,24 @@ +// SPDX-License-Identifier: MPL-2.0 +namespace wawa.Schemas +{ + /// + /// Provides a simple fluent builder API for building the + /// schema object that Tweaks can use to format your mod settings. + /// + [UsedImplicitly] + struct AssemblyDoc; +} + +namespace wawa.Schemas +{ + /// Contains the core functionality of the library. + [UsedImplicitly] + struct NamespaceDoc; +} + +namespace wawa.Schemas.Domains +{ + /// Contains objects returned by the fluent builder APIs. + [UsedImplicitly] + struct NamespaceDoc; +} diff --git a/wawa.TwitchPlays/README.md b/wawa.TwitchPlays/README.md index 19881b8..27c2749 100755 --- a/wawa.TwitchPlays/README.md +++ b/wawa.TwitchPlays/README.md @@ -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) --- diff --git a/wawa.TwitchPlays/Source/Internals/NamespaceDoc.cs b/wawa.TwitchPlays/Source/Internals/NamespaceDoc.cs index 8e5374f..457db64 100755 --- a/wawa.TwitchPlays/Source/Internals/NamespaceDoc.cs +++ b/wawa.TwitchPlays/Source/Internals/NamespaceDoc.cs @@ -1,8 +1,9 @@ // SPDX-License-Identifier: MPL-2.0 -#pragma warning disable 3005, MA0048, SA1300, SA1403 namespace wawa.TwitchPlays { - /// Adds an extensive system for creating Twitch Plays components that are attached to modded modules. + /// + /// Adds an extensive system for creating Twitch Plays components that are attached to modded modules. + /// [UsedImplicitly] struct AssemblyDoc; } diff --git a/wawa.Unity/README.md b/wawa.Unity/README.md index 524f18b..4fb7a68 100755 --- a/wawa.Unity/README.md +++ b/wawa.Unity/README.md @@ -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) ---