Skip to content

Commit

Permalink
minor doc: fix license agreement topic, contributors topic, datastrea…
Browse files Browse the repository at this point in the history
…m::close_all()
  • Loading branch information
samtupy committed Apr 30, 2024
1 parent 53ca838 commit c59c0b3
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/src/appendix/contributers.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ This file contains the names of anyone who has helped contribute to the NVGT eng

* (Patric W)[https://github.com/braillescreen]: some docs, build scripts, beta testing, and miscellaneous organization.
* (Quin G)[https://github.com/thequinbox]: responsible for a growing number of API references documentation topics, beta testing.
* Beta testers including but not limited to Patric Wilson, Quin G, Steven D, Lucas Brown, Liam Erven, DJWolfy, Lukáš Hosnedl, Pragma and Day Garwood, without the valuable feedback and suggestions provided by these people NVGT would have never gotten this far.
* Beta testers including but not limited to Patric Wilson, Quin G, Steven D, Lucas Brown, Liam Erven, DJWolfy, Lukáš Hosnedl, Heaven Games, Pragma and Day Garwood, without the valuable feedback and suggestions provided by these people NVGT would have never gotten this far.
* Last but not least, nothing is worth maintaining or developing without users, and so thank you to everyone who uses this engine and gives it their feedback, time and attention!
5 changes: 4 additions & 1 deletion doc/src/appendix/license agreement.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# NVGT - NonVisual Gaming Toolkit
# License Agreement
NVGT - NonVisual Gaming Toolkit

Copyright (c) 2022-2024 Sam Tupy

[nvgt.gg](https://nvgt.gg)

This software is provided "as-is", without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/**
Close a datastream as well as any that are connected to it.
bool close_all();
## Returns:
bool: true if the stream and any connected to it could be closed, false otherwise.
## Remarks:
This is exactly the same thing as calling the close method with the close_connected boolean argument set to true. On the default datastream class it will have no effect besides freeing the internal string, however you can look at the example below to see a case where there is an effect by calling close_all().
*/

// Example:
void main() {
datastream ds;
hex_encoder h(ds);
h.write("hi");
h.close_all(); // Will also close the datastream called ds because it is connected to the hex encoder.
alert("example", ds.active); // Will display false, indicating that calling h.close_all() also caused ds.close() to implicitly be called.
}

0 comments on commit c59c0b3

Please sign in to comment.