diff --git a/ansi/src/main/javadoc/overview.html b/ansi/src/main/javadoc/overview.html new file mode 100644 index 00000000..b557c7b1 --- /dev/null +++ b/ansi/src/main/javadoc/overview.html @@ -0,0 +1,23 @@ + + + +

Welcome to the sos!engine API documentation!
+ You are currently in the documentation for the ansi subsystem, allowing ANSI escape sequences to be used using Jansi.

+ diff --git a/ansi/src/main/javadoc/theme.css b/ansi/src/main/javadoc/theme.css new file mode 120000 index 00000000..681484a8 --- /dev/null +++ b/ansi/src/main/javadoc/theme.css @@ -0,0 +1 @@ +../../../../src/main/javadoc/theme.css \ No newline at end of file diff --git a/base/src/main/javadoc/overview.html b/base/src/main/javadoc/overview.html index d79ef2df..295f6bb6 100644 --- a/base/src/main/javadoc/overview.html +++ b/base/src/main/javadoc/overview.html @@ -19,5 +19,4 @@

Welcome to the sos!engine API documentation!
You are currently in the documentation for the base subsystem, the core of the engine.

-

The most interesting parts for developers wanting to use the engine are:

diff --git a/graphics/glfw/src/main/javadoc/overview.html b/graphics/glfw/src/main/javadoc/overview.html new file mode 100644 index 00000000..071980d7 --- /dev/null +++ b/graphics/glfw/src/main/javadoc/overview.html @@ -0,0 +1,24 @@ + + + +

Welcome to the sos!engine API documentation!
+ You are currently in the documentation for the glfw subsystem, allowing Graphics APIs to easily implement window and monitor support.

+

This subsystem does not provide any utility for your application, as it's meant to be used by Graphics APIs and just implements interfaces and classes from the graphics subsystem.

+ diff --git a/graphics/opengl/src/main/javadoc/overview.html b/graphics/opengl/src/main/javadoc/overview.html new file mode 100644 index 00000000..9883bd5b --- /dev/null +++ b/graphics/opengl/src/main/javadoc/overview.html @@ -0,0 +1,24 @@ + + + +

Welcome to the sos!engine API documentation!
+ You are currently in the documentation for the opengl subsystem, allowing the OpenGL Graphics API to be used.

+

This subsystem does not provide any utility for your application, as it just implements interfaces and classes from the graphics subsystem.

+ diff --git a/graphics/src/main/javadoc/overview.html b/graphics/src/main/javadoc/overview.html new file mode 100644 index 00000000..2cbb49ec --- /dev/null +++ b/graphics/src/main/javadoc/overview.html @@ -0,0 +1,24 @@ + + + +

Welcome to the sos!engine API documentation!
+ You are currently in the documentation for the graphics subsystem, which provides APIs for interfacing with Graphics APIs.

+

This subsystem largely does not provide any utility for your application, as it's interfaces and classes are meant to be implemented by Graphics APIs.

+ diff --git a/graphics/vulkan/src/main/javadoc/overview.html b/graphics/vulkan/src/main/javadoc/overview.html new file mode 100644 index 00000000..618963ae --- /dev/null +++ b/graphics/vulkan/src/main/javadoc/overview.html @@ -0,0 +1,24 @@ + + + +

Welcome to the sos!engine API documentation!
+ You are currently in the documentation for the vulkan subsystem, allowing the Vulkan Graphics API to be used.

+

This subsystem does not provide any utility for your application, as it just implements interfaces and classes from the graphics subsystem.

+ diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html index 23b474a2..a307fa70 100644 --- a/src/main/javadoc/overview.html +++ b/src/main/javadoc/overview.html @@ -21,5 +21,5 @@ You are currently viewing the API documentation of the StarOpenSource Engine and it's official subsystems.

For a simplified documentation, see the sos!engine documentation.
- For the engine source code, visit sos!git.

+ For the engine source code, visit sos!git.

diff --git a/src/main/javadoc/theme.css b/src/main/javadoc/theme.css index 7b64a94c..58cdbb43 100644 --- a/src/main/javadoc/theme.css +++ b/src/main/javadoc/theme.css @@ -1270,6 +1270,11 @@ pre.snippet .highlighted { background-color: var(--snippet-highlight-color); border-radius: 10%; } +/* + This stylesheet file makes the page appear dark. + Stolen from: + https://docs.oracle.com/en/java/javase/21/javadoc/programmers-guide-javadoc-css-themes.html + */ :root { --body-text-color: #e0e0e3; --block-text-color: #e6e7ef;