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
1414 // Distributed under the Apache License, Version 2.0.
1515 // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
1616 //
17−
17+/** @addtogroup ScriptEngine
18+ * @{
19+*/
1820 #pragma once
1921 #ifndef hifi_ConsoleScriptingInterface_h
2022 #define hifi_ConsoleScriptingInterface_h
@@ -37,7 +39,7 @@ · 16 unmodified lines
3739 * @hifi-server-entity
3840 * @hifi-assignment-client
3941 */
40−// Scriptable interface of "console" object. Used exclusively in the JavaScript API
42+/// Provides the <code><a href="https://apidocs.vircadia.dev/console.html">console</a></code> scripting API
4143 class ConsoleScriptingInterface : public QObject, protected QScriptable {
4244 Q_OBJECT
4345 public:
@@ -220,3 +222,4 @@ private: · 176 unmodified lines
220222 };
221223
222224 #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