Autres/audacity
1
0
Fork 0
mirror of https://github.com/cookiengineer/audacity synced 2025-08-16 08:34:10 +02:00
Code Issues Releases Wiki Activity

Clear TODO: comments for Nyquist docs

Browse Source
This commit is contained in:
Steve Daulton 2018-04-19 22:20:51 +01:00
parent b71b805534
commit 7bc32734ae
1 changed files with 5 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/effects/nyquist/Nyquist.cpp
View File

@ -483,15 +483,16 @@ bool NyquistEffect::SetAutomationParameters(CommandParameters & parms)
bool NyquistEffect::Init() bool NyquistEffect::Init()
{ {
// TODO: Document: Init() is called each time the effect is called but // When Nyquist Prompt spawns an effect GUI, Init() is called for Nyquist Prompt,
// AFTER the UI (if any) has been created, so headers that affect the UI // and then again for the spawned (mExternal) effect.
// are only initialised at the start of the session.
// EffectType may not be defined in script, so // EffectType may not be defined in script, so
// reset each time we call the Nyquist Prompt. // reset each time we call the Nyquist Prompt.
if (mIsPrompt) { if (mIsPrompt) {
mType = EffectTypeProcess;
mName = XO("Nyquist Prompt"); mName = XO("Nyquist Prompt");
// Reset effect type each time we call the Nyquist Prompt.
mType = EffectTypeProcess;
mIsSpectral = false;
mDebugButton = true; // Debug button always enabled for Nyquist Prompt. mDebugButton = true; // Debug button always enabled for Nyquist Prompt.
mEnablePreview = true; // Preview button always enabled for Nyquist Prompt. mEnablePreview = true; // Preview button always enabled for Nyquist Prompt.
} }
@ -954,10 +955,6 @@ bool NyquistEffect::ProcessOne()
nyx_rval rval; nyx_rval rval;
wxString cmd; wxString cmd;
// TODO: Document.
// Nyquist default latency is 300 ms, which is rather conservative and
// too long when playback set to ALSA (bug 570), so we'll use 100 ms like Audacity.
cmd += wxT("(snd-set-latency 0.1)"); cmd += wxT("(snd-set-latency 0.1)");
if (mVersion >= 4) { if (mVersion >= 4) {
@ -1734,8 +1731,6 @@ bool NyquistEffect::Parse(
return true; return true;
} }
// TODO: Update documentation.
if (len >= 2 && tokens[0] == wxT("debugflags")) { if (len >= 2 && tokens[0] == wxT("debugflags")) {
for (int i = 1; i < len; i++) { for (int i = 1; i < len; i++) {
// "trace" sets *tracenable* (LISP) or *sal-traceback* (SAL) // "trace" sets *tracenable* (LISP) or *sal-traceback* (SAL)
@ -1852,7 +1847,6 @@ bool NyquistEffect::Parse(
return true; return true;
} }
// TODO: Document.
// Page name in Audacity development manual // Page name in Audacity development manual
if (len >= 2 && tokens[0] == wxT("manpage")) { if (len >= 2 && tokens[0] == wxT("manpage")) {
// do not translate // do not translate
@ -1860,7 +1854,6 @@ bool NyquistEffect::Parse(
return true; return true;
} }
// TODO: Document.
// Local Help file // Local Help file
if (len >= 2 && tokens[0] == wxT("helpfile")) { if (len >= 2 && tokens[0] == wxT("helpfile")) {
// do not translate // do not translate
@ -1868,7 +1861,6 @@ bool NyquistEffect::Parse(
return true; return true;
} }
// TODO: Document.
// Debug button may be disabled for release plug-ins. // Debug button may be disabled for release plug-ins.
if (len >= 2 && tokens[0] == wxT("debugbutton")) { if (len >= 2 && tokens[0] == wxT("debugbutton")) {
if (tokens[1] == wxT("disabled") || tokens[1] == wxT("false")) { if (tokens[1] == wxT("disabled") || tokens[1] == wxT("false")) {