Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Jan 9, 2024
0 parents commit 54810c2
Show file tree
Hide file tree
Showing 518 changed files with 204,324 additions and 0 deletions.
1,659 changes: 1,659 additions & 0 deletions 404.html

Large diffs are not rendered by default.

1,747 changes: 1,747 additions & 0 deletions CHANGELOG.html

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions assets/.doxy/cAPI/cAPI/annotated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

# Class List


Here are the classes, structs, unions and interfaces with brief descriptions:

* **struct** [**SandwichError**](structSandwichError.md) _An error code._
* **struct** [**SandwichIO**](structSandwichIO.md) _A generic I/O interface._
* **struct** [**SandwichIOOwned**](structSandwichIOOwned.md) _An IO owned by the Sandwich Library._
* **struct** [**SandwichTunnelConfigurationSerialized**](structSandwichTunnelConfigurationSerialized.md) _A serialized_ `TunnelConfiguration` _message._
* **struct** [**SandwichTunnelContextConfigurationSerialized**](structSandwichTunnelContextConfigurationSerialized.md) _A serialized_ `Configuration` _message._

7 changes: 7 additions & 0 deletions assets/.doxy/cAPI/cAPI/class_member_enums.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

# Class Member Enums


Nothing related to **Class Member Enums** found.


7 changes: 7 additions & 0 deletions assets/.doxy/cAPI/cAPI/class_member_functions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

# Class Member Functions


Nothing related to **Class Member Functions** found.


7 changes: 7 additions & 0 deletions assets/.doxy/cAPI/cAPI/class_member_typedefs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

# Class Member Typedefs


Nothing related to **Class Member Typedefs** found.


63 changes: 63 additions & 0 deletions assets/.doxy/cAPI/cAPI/class_member_variables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@

# Class Member Variables



## c

* **code** ([**SandwichError**](structSandwichError.md))


## d

* **details** ([**SandwichError**](structSandwichError.md))


## f

* **flush** ([**SandwichIO**](structSandwichIO.md))
* **freeptr** ([**SandwichIOOwned**](structSandwichIOOwned.md))


## i

* **io** ([**SandwichIOOwned**](structSandwichIOOwned.md))


## k

* **kind** ([**SandwichError**](structSandwichError.md))


## m

* **msg** ([**SandwichError**](structSandwichError.md))


## n

* **n** ([**SandwichTunnelConfigurationSerialized**](structSandwichTunnelConfigurationSerialized.md), [**SandwichTunnelContextConfigurationSerialized**](structSandwichTunnelContextConfigurationSerialized.md))


## r

* **read** ([**SandwichIO**](structSandwichIO.md))


## s

* **src** ([**SandwichTunnelConfigurationSerialized**](structSandwichTunnelConfigurationSerialized.md), [**SandwichTunnelContextConfigurationSerialized**](structSandwichTunnelContextConfigurationSerialized.md))


## u

* **uarg** ([**SandwichIO**](structSandwichIO.md))


## w

* **write** ([**SandwichIO**](structSandwichIO.md))




63 changes: 63 additions & 0 deletions assets/.doxy/cAPI/cAPI/class_members.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@

# Class Members



## c

* **code** ([**SandwichError**](structSandwichError.md))


## d

* **details** ([**SandwichError**](structSandwichError.md))


## f

* **flush** ([**SandwichIO**](structSandwichIO.md))
* **freeptr** ([**SandwichIOOwned**](structSandwichIOOwned.md))


## i

* **io** ([**SandwichIOOwned**](structSandwichIOOwned.md))


## k

* **kind** ([**SandwichError**](structSandwichError.md))


## m

* **msg** ([**SandwichError**](structSandwichError.md))


## n

* **n** ([**SandwichTunnelConfigurationSerialized**](structSandwichTunnelConfigurationSerialized.md), [**SandwichTunnelContextConfigurationSerialized**](structSandwichTunnelContextConfigurationSerialized.md))


## r

* **read** ([**SandwichIO**](structSandwichIO.md))


## s

* **src** ([**SandwichTunnelConfigurationSerialized**](structSandwichTunnelConfigurationSerialized.md), [**SandwichTunnelContextConfigurationSerialized**](structSandwichTunnelContextConfigurationSerialized.md))


## u

* **uarg** ([**SandwichIO**](structSandwichIO.md))


## w

* **write** ([**SandwichIO**](structSandwichIO.md))




13 changes: 13 additions & 0 deletions assets/.doxy/cAPI/cAPI/classes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

# Class Index


## s

* [**SandwichError**](structSandwichError.md)
* [**SandwichIO**](structSandwichIO.md)
* [**SandwichIOOwned**](structSandwichIOOwned.md)
* [**SandwichTunnelConfigurationSerialized**](structSandwichTunnelConfigurationSerialized.md)
* [**SandwichTunnelContextConfigurationSerialized**](structSandwichTunnelContextConfigurationSerialized.md)


86 changes: 86 additions & 0 deletions assets/.doxy/cAPI/cAPI/dir_49e56c817e5e54854c35e136979f97ca.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@


# Dir docs



[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md)














## Directories

| Type | Name |
| ---: | :--- |
| dir | [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) <br> |

























































------------------------------
The documentation for this class was generated from the following file `docs/`

95 changes: 95 additions & 0 deletions assets/.doxy/cAPI/cAPI/dir_f6ef5a90171f1138cc160f006fc74f9c.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@


# Dir docs/sandwich\_c



[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md)












## Files

| Type | Name |
| ---: | :--- |
| file | [**error.h**](error_8h.md) <br>_Error handling for the Sandwich library._ |
| file | [**error\_codes.h**](error__codes_8h.md) <br>_Sandwich errors specification._ |
| file | [**export.h**](export_8h.md) <br> |
| file | [**io.h**](io_8h.md) <br>_I/O abstraction for Sandwich._ |
| file | [**ioerrors.h**](ioerrors_8h.md) <br>_Sandwich I/O errors specification._ |
| file | [**lib.h**](lib_8h.md) <br>_Top-level context for the Sandwich library._ |
| file | [**listener.h**](listener_8h.md) <br>_Sandwich C library, on top of the Rust implementation._ |
| file | [**sandwich.h**](sandwich_8h.md) <br>_Sandwich C library, on top of the Rust implementation._ |
| file | [**tunnel.h**](tunnel_8h.md) <br>_Sandwich Tunnel API._ |
| file | [**tunnel\_types.h**](tunnel__types_8h.md) <br>_Sandwich tunnel types and states specification._ |



























































------------------------------
The documentation for this class was generated from the following file `docs/sandwich_c/`

Loading

0 comments on commit 54810c2

Please sign in to comment.