ActiveX review by tonsofpcs

activex/axvlc.idl

@@ -20,6 +20,9 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+//comments terminated by [t] are by tonsofpcs, regarding the string review.  April 02, 2006. [t]
+//Possibly change all instances of "the current playlist" to "the playlist" and "current playlist" to "the playlist" [t]
+
 [
   uuid(DF2BBE39-40A8-433b-A279-073F48DA94B6),
   version(1.0),
@@ -68,9 +71,9 @@ library AXVLC
     ]
     interface IVLCControl : IDispatch
     {
-        [id(DISPID_Visible), propget, bindable, helpstring("Shows or hides plugin.")]
+        [id(DISPID_Visible), propget, bindable, helpstring("Returns plugin visibility.")]
         HRESULT Visible([out, retval] VARIANT_BOOL* visible);
-        [id(DISPID_Visible), propput, bindable, helpstring("Shows or hides plugin.")]
+	[id(DISPID_Visible), propput, bindable, helpstring("Specifies plugin visibility.")]
         HRESULT Visible([in] VARIANT_BOOL visible);
         [helpstring("Play current target in playlist.")]
         HRESULT play();
@@ -80,35 +83,35 @@ library AXVLC
         HRESULT stop();
         [id(DISPID_Playing), hidden, propget, helpstring("Returns whether VLC is playing.")]
         HRESULT Playing([out, retval] VARIANT_BOOL* isPlaying);
-        [id(DISPID_Position), propget, helpstring("Specifies playback position within current target in playlist, position is a relative value ranging from 0.0 to 1.0.")]
+	[id(DISPID_Position), propget, helpstring("Returns playback position within the current item.  Position is a relative value ranging from 0.0 to 1.0.")]
         HRESULT Position([out, retval] float* position);
-        [id(DISPID_Position), propput, helpstring("Specifies playback position within current target in playlist, position is a relative value ranging from 0.0 to 1.0.")]
+	[id(DISPID_Position), propput, helpstring("Specifies playback position within the current item.  Position is a relative value ranging from 0.0 to 1.0.")]
         HRESULT Position([in] float position);
-        [id(DISPID_Time), propget, helpstring("Specifies playback time relative to the start of current target in playlist.")]
+	[id(DISPID_Time), propget, helpstring("Returns playback time relative to the start of the current item.")]
         HRESULT Time([out, retval] int* seconds);
-        [id(DISPID_Time), propput, helpstring("Specifies playback time relative to the start of current target in playlist.")]
+	[id(DISPID_Time), propput, helpstring("Specifies playback time relative to the start of the current item.")]
         HRESULT Time([in] int seconds);
-        [helpstring("Advance or backtrack playback time, relative to current time.")]
+	[helpstring("Advance or backtrack playback time, relative to current time.")]  //possibly find a better word to replace 'backtrack' [t]
         HRESULT shuttle([in] int seconds);
-        [helpstring("Switch between normal and fullscreen video.")]
+	[helpstring("Switch video between normal and fullscreen view modes.")]
         HRESULT fullscreen();
-        [id(DISPID_Length), propget, hidden, helpstring("Returns total length in seconds of current target in playlist, may be unknown.")]
+	[id(DISPID_Length), propget, hidden, helpstring("Returns the total length, in seconds, of the current item, may be unknown.")]
         HRESULT Length([out, retval] int* seconds);
-        [helpstring("Increases playback speed, one of 1x, 2x, 4x, 8x.")]
+	[helpstring("Increases playback speed.  Possible speeds are: 1x, 2x, 4x, 8x.")]
         HRESULT playFaster();
-        [helpstring("Decreases playback speed, one of 1x, 2x, 4x, 8x.")]
+	[helpstring("Decreases playback speed.  Possible speeds are: 1x, 2x, 4x, 8x.")]
         HRESULT playSlower();
-        [id(DISPID_Volume), propget, helpstring("Specifies playback sound volume, ranges from 0 to 200%.")]
+	id(DISPID_Volume), propget, helpstring("Returns playback volume, ranges from 0 to 200%.")]  //possibly remove % from 'ranges', change to 'values', and specify that 200 is equivilant to 200% (remember, 200% == 2.0, but this gets an int not a float) [t]
         HRESULT Volume([out, retval] int* volume);
-        [id(DISPID_Volume), propput, helpstring("Specifies playback sound volume, ranges from 0 to 200%.")]
+	[id(DISPID_Volume), propput, helpstring("Specifies playback volume, ranges from 0 to 200%.")]
         HRESULT Volume([in] int volume);
-        [helpstring("Mute/unmute playback sound volume.")]
+	[helpstring("Mute/unmute playback audio.")]
         HRESULT toggleMute();
-        [helpstring("Set a value to a VLC variable.")]
+	[helpstring("Set a value for a VLC variable.")]
         HRESULT setVariable([in] BSTR name, [in] VARIANT value);
         [helpstring("Retrieve the value of a VLC variable.")]
         HRESULT getVariable([in] BSTR name, [out, retval] VARIANT *value);
-        [helpstring("Add a target to the current playlist.")]
+	[helpstring("Add an item to the playlist.")]
 
 /*
 ** use VARIANT rather than a SAFEARRAY as argument type
@@ -116,7 +119,7 @@ library AXVLC
 */
 
         HRESULT addTarget([in] BSTR uri, [in] VARIANT options, [in] enum VLCPlaylistMode mode, [in] int position);
-        [propget, helpstring("Returns index of current target in playlist.")]
+        [propget, helpstring("Returns index of current item in playlist.")]
         HRESULT PlaylistIndex([out, retval] int* index);
         [propget, helpstring("Returns number of items in playlist.")]
         HRESULT PlaylistCount([out, retval] int* index);
@@ -128,9 +131,9 @@ library AXVLC
         HRESULT playlistClear();
         [propget, hidden, helpstring("Returns VLC Version.")]
         HRESULT VersionInfo([out, retval] BSTR* version);
-        [id(DISPID_MRL), propget, helpstring("Returns initial MRL in default playlist")]
+	[id(DISPID_MRL), propget, helpstring("Returns the first MRL in the playlist")]
         HRESULT MRL([out, retval] BSTR* mrl);
-        [id(DISPID_MRL), propput, helpstring("Specifies initial MRL in default playlist")]
+        [id(DISPID_MRL), propput, helpstring("Specifies the first MRL in the playlist")]
         HRESULT MRL([in] BSTR mrl);
         [id(DISPID_AutoPlay), propget, helpstring("Specifies whether default playlist is played on startup")]
         HRESULT AutoPlay([out, retval] VARIANT_BOOL* autoplay);
@@ -155,11 +158,11 @@ library AXVLC
     {
         properties:
         methods:
-            [id(DISPID_PlayEvent), helpstring("Playback in progress")]
+            [id(DISPID_PlayEvent), helpstring("Playing")]
             void play();
-            [id(DISPID_PauseEvent), helpstring("Playback has paused")]
+            [id(DISPID_PauseEvent), helpstring("Paused")]
             void pause();
-            [id(DISPID_StopEvent), helpstring("Playback has stopped")]
+            [id(DISPID_StopEvent), helpstring("Stopped")]
             void stop();
     };