History

Improved JSDoc comments.

Nissim Hadar committed 8 years ago

Commit a843a531 parent 049beba1 file · +9 −3Browse files

Showing the changes to interface/src/scripting/WindowScriptingInterface.h (1 of 1 file). Show all

Unified · Split

interface/src/scripting/WindowScriptingInterface.h+9−3
@@ -325,6 +325,7 @@ public slots: · 324 unmodified lines
325325 * {@link Window.stillSnapshotTaken|stillSnapshotTaken} is emitted; when a still image plus moving images are captured,
326326 * {@link Window.processingGifStarted|processingGifStarted} and {@link Window.processingGifCompleted|processingGifCompleted}
327327 * are emitted. The path to store the snapshots and the length of the animated GIF to capture are specified in Settings >
328+ * NOTE: to provide a non-default value - all previous parameters must be provided.
328329 * General > Snapshots.
329330 * @function Window.takeSnapshot
330331 * @param {boolean} notify=true - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken}
@@ -334,8 +335,10 @@ public slots: · 3 unmodified lines
334335 * @param {number} aspectRatio=0 - The width/height ratio of the snapshot required. If the value is <code>0</code> the
335336 * full resolution is used (window dimensions in desktop mode; HMD display dimensions in HMD mode), otherwise one of the
336337 * dimensions is adjusted in order to match the aspect ratio.
337− * @param {string} filename="" - If this value is not given, or is <code>""</code> then the image will be saved to this filename, with an appended ",jpg".
338− * otherwise, the image will be saved as 'hifi-snap-by-<user name>-YYYY-MM-DD_HH-MM-SS'.
338+ * @param {string} filename="" - If this parameter is not given, the image will be saved as 'hifi-snap-by-<user name>-YYYY-MM-DD_HH-MM-SS'.
339+ * If this parameter is <code>""</code> then the image will be saved as ".jpg".
340+ * Otherwise, the image will be saved to this filename, with an appended ".jpg".
341+ *
339342 * @example <caption>Using the snapshot function and signals.</caption>
340343 * function onStillSnapshotTaken(path, notify) {
341344 * print("Still snapshot taken: " + path);
@@ -364,8 +367,11 @@ public slots: · 22 unmodified lines
364367
365368 /**jsdoc
366369 * Takes a still snapshot of the current view from the secondary camera that can be set up through the {@link Render} API.
370+ * NOTE: to provide a non-default value - all previous parameters must be provided.
367371 * @function Window.takeSecondaryCameraSnapshot
368− * @param {string} filename="" - If this value is not given, or is <code>""</code> then the image will be saved to this filename, with an appended ".jpg".
372+ * @param {string} filename="" - If this parameter is not given, the image will be saved as 'hifi-snap-by-<user name>-YYYY-MM-DD_HH-MM-SS'.
373+ * If this parameter is <code>""</code> then the image will be saved as ".jpg".
374+ * Otherwise, the image will be saved to this filename, with an appended ".jpg".
369375 *
370376 * var filename = QString();
371377 */

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t