Add WASI doc links for flags and enums

dylibso · Oct 3, 2024 · d14ab12 · d14ab12
1 parent b1e14c2
commit d14ab12
Show file tree

Hide file tree

Showing 10 changed files with 31 additions and 2 deletions.
diff --git a/wasi/README.md b/wasi/README.md
@@ -6,8 +6,10 @@ by many of the compilers out there.
 
 ## Version Support
 
-There are currently 2 versions of WASI at the moment, [preview1](https://github.com/WebAssembly/WASI/blob/main/legacy/README.md) and [preview2](https://github.com/WebAssembly/WASI/blob/main/preview2/README.md). This library is currently
-aimed at `preview1`.
+There are currently 2 versions of WASI at the moment,
+[preview1](https://github.com/WebAssembly/WASI/blob/v0.2.1/legacy/README.md) and
+[preview2](https://github.com/WebAssembly/WASI/blob/v0.2.1/wasip2/README.md).
+This library is currently aimed at `preview1`.
 
 > **Note**: You might hear the terms `preview1/preview1` or `0.1/0.2` when referring to the versions inside the WASI docs.
 > And you might hear `wasip1` when being used as a flag to a compiler target. We tend to prefer the nomenclature wasip1 / wasip2.

diff --git a/wasi/src/main/java/com/dylibso/chicory/wasi/WasiClockId.java b/wasi/src/main/java/com/dylibso/chicory/wasi/WasiClockId.java
@@ -1,5 +1,8 @@
 package com.dylibso.chicory.wasi;
 
+/**
+ * WASI <a href="https://github.com/WebAssembly/WASI/blob/v0.2.1/legacy/preview1/docs.md#clockid">clockid</a>
+ */
 final class WasiClockId {
     private WasiClockId() {}
 

diff --git a/wasi/src/main/java/com/dylibso/chicory/wasi/WasiErrno.java b/wasi/src/main/java/com/dylibso/chicory/wasi/WasiErrno.java
@@ -1,5 +1,8 @@
 package com.dylibso.chicory.wasi;
 
+/**
+ * WASI <a href="https://github.com/WebAssembly/WASI/blob/v0.2.1/legacy/preview1/docs.md#errno">errno</a>
+ */
 enum WasiErrno {
     ESUCCESS,
     E2BIG,

diff --git a/wasi/src/main/java/com/dylibso/chicory/wasi/WasiFdFlags.java b/wasi/src/main/java/com/dylibso/chicory/wasi/WasiFdFlags.java
@@ -1,5 +1,8 @@
 package com.dylibso.chicory.wasi;
 
+/**
+ * WASI <a href="https://github.com/WebAssembly/WASI/blob/v0.2.1/legacy/preview1/docs.md#fdflags">fdflags</a>
+ */
 final class WasiFdFlags {
     private WasiFdFlags() {}
 

diff --git a/wasi/src/main/java/com/dylibso/chicory/wasi/WasiFileType.java b/wasi/src/main/java/com/dylibso/chicory/wasi/WasiFileType.java
@@ -1,5 +1,8 @@
 package com.dylibso.chicory.wasi;
 
+/**
+ * WASI <a href="https://github.com/WebAssembly/WASI/blob/v0.2.1/legacy/preview1/docs.md#filetype">filetype</a>
+ */
 enum WasiFileType {
     UNKNOWN,
     BLOCK_DEVICE,

diff --git a/wasi/src/main/java/com/dylibso/chicory/wasi/WasiFstFlags.java b/wasi/src/main/java/com/dylibso/chicory/wasi/WasiFstFlags.java
@@ -1,5 +1,8 @@
 package com.dylibso.chicory.wasi;
 
+/**
+ * WASI <a href="https://github.com/WebAssembly/WASI/blob/v0.2.1/legacy/preview1/docs.md#fstflags">fstflags</a>
+ */
 final class WasiFstFlags {
     private WasiFstFlags() {}
 

diff --git a/wasi/src/main/java/com/dylibso/chicory/wasi/WasiLookupFlags.java b/wasi/src/main/java/com/dylibso/chicory/wasi/WasiLookupFlags.java
@@ -1,5 +1,8 @@
 package com.dylibso.chicory.wasi;
 
+/**
+ * WASI <a href="https://github.com/WebAssembly/WASI/blob/v0.2.1/legacy/preview1/docs.md#lookupflags">lookupflags</a> flags
+ */
 final class WasiLookupFlags {
     private WasiLookupFlags() {}
 

diff --git a/wasi/src/main/java/com/dylibso/chicory/wasi/WasiOpenFlags.java b/wasi/src/main/java/com/dylibso/chicory/wasi/WasiOpenFlags.java
@@ -1,5 +1,8 @@
 package com.dylibso.chicory.wasi;
 
+/**
+ * WASI <a href="https://github.com/WebAssembly/WASI/blob/v0.2.1/legacy/preview1/docs.md#oflags">oflags</a>
+ */
 final class WasiOpenFlags {
     private WasiOpenFlags() {}
 

diff --git a/wasi/src/main/java/com/dylibso/chicory/wasi/WasiRights.java b/wasi/src/main/java/com/dylibso/chicory/wasi/WasiRights.java
@@ -1,5 +1,8 @@
 package com.dylibso.chicory.wasi;
 
+/**
+ * WASI <a href="https://github.com/WebAssembly/WASI/blob/v0.2.1/legacy/preview1/docs.md#rights">rights</a>
+ */
 final class WasiRights {
     private WasiRights() {}
 

diff --git a/wasi/src/main/java/com/dylibso/chicory/wasi/WasiWhence.java b/wasi/src/main/java/com/dylibso/chicory/wasi/WasiWhence.java
@@ -1,5 +1,8 @@
 package com.dylibso.chicory.wasi;
 
+/**
+ * WASI <a href="https://github.com/WebAssembly/WASI/blob/v0.2.1/legacy/preview1/docs.md#whence">whence</a>
+ */
 final class WasiWhence {
     private WasiWhence() {}