History

Ensuring minimal documentation for classes declared in script-engine

Heather Anderson committed 5 years ago

Commit 259cd201 parent f1b4c8e41 files · +211 −63Browse files

Showing the changes to libraries/script-engine/src/ConsoleScriptingInterface.h (1 of 41 files). Show all

Unified · Split

libraries/script-engine/src/ConsoleScriptingInterface.h+5−2
@@ -14,7 +14,9 @@ · 13 unmodified lines
14// Distributed under the Apache License, Version 2.0.14// Distributed under the Apache License, Version 2.0.
15// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html15// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
16//16//
17 17/** @addtogroup ScriptEngine
18 * @{
19*/
18#pragma once20#pragma once
19#ifndef hifi_ConsoleScriptingInterface_h21#ifndef hifi_ConsoleScriptingInterface_h
20#define hifi_ConsoleScriptingInterface_h22#define hifi_ConsoleScriptingInterface_h
@@ -37,7 +39,7 @@ · 16 unmodified lines
37 * @hifi-server-entity39 * @hifi-server-entity
38 * @hifi-assignment-client40 * @hifi-assignment-client
39 */41 */
40// Scriptable interface of "console" object. Used exclusively in the JavaScript API42/// Provides the <code><a href="https://apidocs.vircadia.dev/console.html">console</a></code> scripting API
41class ConsoleScriptingInterface : public QObject, protected QScriptable {43class ConsoleScriptingInterface : public QObject, protected QScriptable {
42 Q_OBJECT44 Q_OBJECT
43public:45public:
@@ -220,3 +222,4 @@ private: · 176 unmodified lines
220};222};
221 223
222#endif // hifi_ConsoleScriptingInterface_h224#endif // hifi_ConsoleScriptingInterface_h
225/** @}*/

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