Github user mike-jumper commented on a diff in the pull request:
https://github.com/apache/incubator-guacamole-server/pull/118#discussion_r146477301
--- Diff: src/terminal/terminal/terminal.h ---
@@ -492,6 +492,14 @@ int guac_terminal_render_frame(guac_terminal*
terminal);
int guac_terminal_read_stdin(guac_terminal* terminal, char* c, int size);
/**
+ * Manually stop the terminal to forcibly unblock any pending reads/writes,
+ * e.g. forcing guac_terminal_read_stdin() to return and cease all
terminal I/O.
+ * This function has been called in guac_terminal_free(). It could be
useful
+ * when need to stop the terminal before calling guac_terminal_free().
+ */
+void guac_terminal_stop(guac_terminal* term);
--- End diff --
Thanks for documenting the function, but the `term` parameter needs to be
documented as well. Old code from before our more strict documentation
requirements won't have this, but new code (and updated old code) needs it
going forward. See:
http://guacamole.incubator.apache.org/guac-style/#comments-and-documentation
---
