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/UsersScriptingInterface.h (1 of 41 files). Show all

Unified · Split

libraries/script-engine/src/UsersScriptingInterface.h+5−1
@@ -9,7 +9,9 @@ · 8 unmodified lines
99 // Distributed under the Apache License, Version 2.0.
1010 // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
1111 //
12−
12+/** @addtogroup ScriptEngine
13+ * @{
14+*/
1315 #pragma once
1416
1517 #ifndef hifi_UsersScriptingInterface_h
@@ -38,6 +40,7 @@ · 22 unmodified lines
3840 * @property {BanFlags} BAN_BY_FINGERPRINT - Ban user by fingerprint. <em>Read-only.</em>
3941 * @property {BanFlags} BAN_BY_IP - Ban user by IP address. <em>Read-only.</em>
4042 */
43+/// Provides the <code><a href="https://apidocs.vircadia.dev/Users.html">Users</a></code> scripting interface
4144 class UsersScriptingInterface : public QObject, public Dependency {
4245 Q_OBJECT
4346 SINGLETON_DEPENDENCY
@@ -262,3 +265,4 @@ private: · 218 unmodified lines
262265
263266
264267 #endif // hifi_UsersScriptingInterface_h
268+/** @}*/

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