-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix documentation of interface command-line parameters #5
Comments
I think it's very important that the descriptions be clear, distinct, complete, and the same in the (online) documentation and |
https://github.com/vircadia/vircadia/pull/1428/files
// The documented "--disable-lod" does not seem to exist.
// Below are undocumented.
QCommandLineOption noLauncherOption("no-launcher", "Do not execute the launcher.");
QCommandLineOption overrideScriptsPathOption(SCRIPTS_SWITCH, "set scripts <path>", "path");
QCommandLineOption defaultScriptOverrideOption("defaultScriptsOverride", "override defaultsScripts.js.", "string");
QCommandLineOption responseTokensOption("tokens", "set response tokens <json>.", "json");
QCommandLineOption displayNameOption("displayName", "set user display name <string>.", "string");
// "--traceFile". In my pull request, I change handling for this and add a related parameter "--traceDuration".
// "--clockSkew". I'm not sure if this is still useful for anything.
// "--qmljsdebugger", which appears in output from "--help-all".
Here are additional undocumented parameters I found (not all tested). See my pull request for definitions.
--no-login-suggestion
--traceFile (and in my pull request I add "--traceDuration" to replace some "--traceFile" functionality)
--clockSkew
--testScript
--testResultsLocation
--quitWhenFinished
--fast-heartbeat
Also, "--protocolVersion", which is currently documented, only seems to write to a file (which is a required parameter that must follow it). It does not "display" the output.
The text was updated successfully, but these errors were encountered: