Github user mike-jumper commented on a diff in the pull request:
https://github.com/apache/incubator-guacamole-client/pull/14#discussion_r65634557
--- Diff: guacamole-common-js/src/main/webapp/modules/ArrayBufferWriter.js
---
@@ -62,6 +62,20 @@ Guacamole.ArrayBufferWriter = function(stream) {
}
/**
+ * The maximum length of any blob sent by this
Guacamole.ArrayBufferWriter,
+ * in bytes. Data sent via
+ * {@link Guacamole.ArrayBufferWriter#sendData|sendData()} which
exceeds
--- End diff --
It's the way you provide text for JSDoc3's `@link`:
http://usejsdoc.org/tags-inline-link.html
Re-reading the above ... it looks like there's a more readable, more
markdown-y syntax available. Perhaps I should switch over to that before
precedent is set?
I believe this is our first use of `@link` in the docs.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
