Update of /cvsroot/audacity/audacity-src/src/effects/nyquist
In directory
sfp-cvsdas-1.v30.ch3.sourceforge.com:/tmp/cvs-serv8551/src/effects/nyquist
Modified Files:
Nyquist.h
Log Message:
Add documentation of some key members worked out whilst reviewing a proposed
patch to this code
Index: Nyquist.h
===================================================================
RCS file: /cvsroot/audacity/audacity-src/src/effects/nyquist/Nyquist.h,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -d -r1.18 -r1.19
--- Nyquist.h 4 Nov 2009 02:04:46 -0000 1.18
+++ Nyquist.h 1 Jan 2010 21:23:00 -0000 1.19
@@ -54,7 +54,10 @@
{
public:
- EffectNyquist(wxString fname);
+ /** @param fName File name of the Nyquist script defining this effect. If
+ * an empty string, then prompt the user for the Nyquist code to interpret.
+ */
+ EffectNyquist(wxString fName);
virtual ~EffectNyquist();
bool SetXlispPath();
@@ -70,6 +73,10 @@
void SetCommand(wxString cmd);
wxString GetOutput();
+ /** Get the name of the effect (taken from the script that is loaded). Note
+ * that this name is currently not translated because the translations
system
+ * doesn't see the lisp files containing the Nyquist effect scripts.
+ * @return The name of the effect */
virtual wxString GetEffectName() {
return mName;
}
@@ -138,8 +145,8 @@
wxString mXlispPath;
- wxFileName mFileName;
- wxDateTime mFileModified;
+ wxFileName mFileName; ///< Name of the Nyquist script file this
effect is loaded from
+ wxDateTime mFileModified; ///< When the script was last modified on
disk
bool mStop;
bool mBreak;
@@ -148,10 +155,14 @@
bool mCompiler;
bool mIsSal;
bool mExternal;
- bool mInteractive;
+ /** True if the code to execute is obtained interactively from the user via
+ * the "Nyquist Prompt", false for all other effects (lisp code read from
+ * files)
+ */
+ bool mInteractive;
bool mOK;
wxString mCmd;
- wxString mName;
+ wxString mName; ///< Name of the Effect
wxString mAction;
wxString mInfo;
bool mDebug;
------------------------------------------------------------------------------
This SF.Net email is sponsored by the Verizon Developer Community
Take advantage of Verizon's best-in-class app development support
A streamlined, 14 day to market process makes app distribution fast and easy
Join now and get one step closer to millions of Verizon customers
http://p.sf.net/sfu/verizon-dev2dev
_______________________________________________
Audacity-cvs mailing list
Audacity-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/audacity-cvs
