win 0.3.1 → 0.3.3

data/HISTORY

@@ -0,0 +1,8 @@
+== 0.0.0 / 2010-01-17
+
+
+== 0.3.2 / 2010-04-17
+
+== 0.3.3 / 2010-04-17
+
+* Moved from Jeweler to own Rake tasks

data/README.rdoc

@@ -20,7 +20,7 @@ You just want to put these function calls into your Ruby code without too much p
 You'd love this to be more or less natural extension of your Ruby code, preferably
 not turning your code base into an ugly spaghetty of CamelCase calls, String/Array
 pack/unpack gymnastics, buffer/pointer allocations, extracting return values
-from [in/out] parameters and checking return codes for 0.
+from <in/out> parameters and checking return codes for 0.
 
 You have several options at this point. You can use 'win32-api' or 'ffi' libraries
 to connect your ruby code to Windows API and manually define wrapper methods for
@@ -119,7 +119,7 @@ Contributors always welcome!
     require 'win/gui/window'
 
     class MyClass
-    include Win::GUI::Window
+    include Win::Gui::Window
 
     fg_window = foreground_window
     puts window_text(fg_window)

data/Rakefile

@@ -1,58 +1,24 @@
-require 'rubygems'
-require 'rake'
+require 'pathname'
+NAME = 'win'
+BASE_PATH = Pathname.new(__FILE__).dirname
+LIB_PATH =  BASE_PATH + 'lib'
+PKG_PATH =  BASE_PATH + 'pkg'
+DOC_PATH =  BASE_PATH + 'rdoc'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "win"
-    gem.summary = %Q{Rubyesque interfaces and wrappers for Windows API functions pre-defined using FFI }
-    gem.description = %Q{Rubyesque interfaces and wrappers for Windows API functions pre-defined using FFI }
-    gem.email = "arvitallian@gmail.com"
-    gem.homepage = "http://github.com/arvicco/win"
-    gem.authors = ["arvicco"]
-    gem.add_dependency "ffi", ">= 0.6.0"
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "cucumber", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
+$LOAD_PATH.unshift LIB_PATH.to_s
+require 'version'
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
+CLASS_NAME = Win
+VERSION = CLASS_NAME::VERSION
 
 begin
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features)
-
-  task :features => :check_dependencies
+  require 'rake'
 rescue LoadError
-  task :features do
-    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
-  end
+  require 'rubygems'
+  gem 'rake', '~> 0.8.3.1'
+  require 'rake'
 end
 
-task :default => :spec
+# Load rakefile tasks
+Dir['tasks/*.rake'].sort.each { |file| load file }
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "win #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.3

data/lib/version.rb

@@ -0,0 +1,8 @@
+require 'pathname'
+
+module Win
+
+  VERSION_FILE = Pathname.new(__FILE__).dirname + '../VERSION'   # :nodoc:
+  VERSION = VERSION_FILE.exist? ? VERSION_FILE.read.strip : nil
+
+end

data/lib/win/dde.rb

@@ -591,7 +591,7 @@ module Win
     #
     # [*Syntax*] UINT RegisterClipboardFormat( LPCTSTR lpszFormat )
     #
-    # lpszFormat:: [in] Pointer to a null-terminated string that names the new format.
+    # lpszFormat:: <in> Pointer to a null-terminated string that names the new format.
     #
     # *Returns*:: :uint or nil. If the function succeeds, the return value identifies the registered clipboard format.
     #             If the function fails, the return value is *nil*(not zero). For error info, call GetLastError.
@@ -617,7 +617,7 @@ module Win
     #
     # [*Syntax*] HDDEDATA CALLBACK DdeCallback( UINT uType, UINT uFmt, HCONV hconv, HDDEDATA hsz1, HDDEDATA hsz2,
     #            HDDEDATA hdata, HDDEDATA dwData1, HDDEDATA dwData2);
-    # uType:: [in] Specifies the type of the current transaction. This parameter consists of a combination of
+    # uType:: <in> Specifies the type of the current transaction. This parameter consists of a combination of
     #         transaction class flags and transaction type flags. The following table describes each of the
     #         transaction classes and provides a list of the transaction types in each class. For information
     #         about a specific transaction type, see the individual description of that type.
@@ -671,16 +671,16 @@ module Win
     #           - XTYP_REGISTER
     #           - XTYP_XACT_COMPLETE
     #           - XTYP_UNREGISTER
-    # uFmt:: [in] Specifies the format in which data is sent or received.
-    # hconv:: [in] Handle to the conversation associated with the current transaction.
-    # hsz1:: [in] Handle to a string. The meaning of this parameter depends on the type of the current transaction.
+    # uFmt:: <in> Specifies the format in which data is sent or received.
+    # hconv:: <in> Handle to the conversation associated with the current transaction.
+    # hsz1:: <in> Handle to a string. The meaning of this parameter depends on the type of the current transaction.
     #        For the meaning of this parameter, see the description of the transaction type.
-    # hsz2:: [in] Handle to a string. The meaning of this parameter depends on the type of the current transaction.
+    # hsz2:: <in> Handle to a string. The meaning of this parameter depends on the type of the current transaction.
     #        For the meaning of this parameter, see the description of the transaction type.
-    # hdata:: [in] Handle to DDE data. The meaning of this parameter depends on the type of the current transaction.
+    # hdata:: <in> Handle to DDE data. The meaning of this parameter depends on the type of the current transaction.
     #         For the meaning of this parameter, see the description of the transaction type.
-    # dwData1:: [in] Specifies transaction-specific data. For the meaning, see the description of the transaction type.
-    # dwData2:: [in] Specifies transaction-specific data. For the meaning, see the description of the transaction type.
+    # dwData1:: <in> Specifies transaction-specific data. For the meaning, see the description of the transaction type.
+    # dwData2:: <in> Specifies transaction-specific data. For the meaning, see the description of the transaction type.
     # *Returns*:: The return value depends on the transaction class. For more information about the return values,
     #             see descriptions of the individual transaction types.
     # ---
@@ -702,7 +702,7 @@ module Win
     #
     # [*Syntax*] UINT DdeInitialize( LPDWORD pidInst, PFNCALLBACK pfnCallback, DWORD afCmd, DWORD ulRes );
     #
-    # pidInst:: [in, out] Pointer to the application instance identifier.
+    # pidInst:: <in, out> Pointer to the application instance identifier.
     #           At initialization, this parameter should point to 0. If the function succeeds, this parameter points
     #           to the instance identifier for the application. This value should be passed as the idInst parameter
     #           in all other DDEML functions that require it. If an application uses multiple instances of the DDEML
@@ -711,7 +711,7 @@ module Win
     #           case, pidInst must point to a valid application-instance identifier.
     # pfnCallback:: Pointer to the application-defined Dynamic Data Exchange DdeCallback function. This function
     #               processes DDE transactions sent by the system. For more information, see the DdeCallback.
-    # afCmd:: [in] Specifies a set of APPCMD_, CBF_, and MF_ flags. The APPCMD_ flags provide special
+    # afCmd:: <in> Specifies a set of APPCMD_, CBF_, and MF_ flags. The APPCMD_ flags provide special
     #         instructions to DdeInitialize. The CBF_ flags specify filters that prevent specific types of transactions
     #         from reaching the callback function. The MF_ flags specify the types of DDE activity that a DDE monitoring
     #         application monitors. Using these flags enhances the performance of a DDE application by eliminating
@@ -767,7 +767,7 @@ module Win
     #
     # [*Syntax*] BOOL DdeUninitialize( DWORD idInst);
     #
-    # idInst:: [in] Specifies the application instance identifier obtained by a previous call to the DdeInitialize.
+    # idInst:: <in> Specifies the application instance identifier obtained by a previous call to the DdeInitialize.
     # *Returns*:: If the function succeeds, the return value is nonzero.
     #             If the function fails, the return value is zero.
     # ---
@@ -786,12 +786,12 @@ module Win
     #
     # [*Syntax*] HSZ DdeCreateStringHandle( DWORD idInst, LPTSTR psz, int iCodePage );
     #
-    # idInst:: [in] Specifies the application instance identifier obtained by a previous call to the
+    # idInst:: <in> Specifies the application instance identifier obtained by a previous call to the
     #          DdeInitialize function.
-    # psz:: [in] Pointer to a buffer that contains the null-terminated string for which a handle
+    # psz:: <in> Pointer to a buffer that contains the null-terminated string for which a handle
     #       is to be created. This string can be up to 255 characters. The reason for this limit is that
     #       DDEML string management functions are implemented using global atoms.
-    # iCodePage:: [in] Specifies the code page used to render the string. This value should be either
+    # iCodePage:: <in> Specifies the code page used to render the string. This value should be either
     #             CP_WINANSI (the default code page) or CP_WINUNICODE, depending on whether the ANSI or Unicode
     #             version of DdeInitialize was called by the client application.
     #
@@ -821,8 +821,8 @@ module Win
     #
     # [*Syntax*] BOOL DdeFreeStringHandle( DWORD idInst, HSZ hsz );
     #
-    # idInst:: [in] Specifies the application instance identifier obtained by a previous call to the DdeInitialize.
-    # hsz:: [in, out] Handle to the string handle to be freed. This handle must have been created by a previous call
+    # idInst:: <in> Specifies the application instance identifier obtained by a previous call to the DdeInitialize.
+    # hsz:: <in, out> Handle to the string handle to be freed. This handle must have been created by a previous call
     #       to the DdeCreateStringHandle function.
     # *Returns*:: If the function succeeds, the return value is nonzero. If the function fails, it is zero.
     # ---
@@ -843,16 +843,16 @@ module Win
     #
     # [*Syntax*] DWORD DdeQueryString( DWORD idInst, HSZ hsz, LPTSTR psz, DWORD cchMax, int iCodePage);
     #
-    # idInst:: [in] Specifies the application instance identifier obtained by a previous call to the DdeInitialize.
-    # hsz:: [in] Handle to the string to copy. This handle must have been created by a previous call to the
+    # idInst:: <in> Specifies the application instance identifier obtained by a previous call to the DdeInitialize.
+    # hsz:: <in> Handle to the string to copy. This handle must have been created by a previous call to the
     #       DdeCreateStringHandle function.
-    # psz:: [in, out] Pointer to a buffer that receives the string. To obtain the length of the string, this parameter
+    # psz:: <in, out> Pointer to a buffer that receives the string. To obtain the length of the string, this parameter
     #       should be set to NULL.
-    # cchMax::  [in] Specifies the length, in TCHARs, of the buffer pointed to by the psz parameter. For the ANSI
+    # cchMax::  <in> Specifies the length, in TCHARs, of the buffer pointed to by the psz parameter. For the ANSI
     #           version of the function, this is the number of bytes; for the Unicode version, this is the number of
     #           characters. If the string is longer than ( cchMax– 1), it will be truncated. If the psz parameter is
     #           set to NULL, this parameter is ignored.
-    # iCodePage:: [in] Code page used to render the string. This value should be either CP_WINANSI or CP_WINUNICODE.
+    # iCodePage:: <in> Code page used to render the string. This value should be either CP_WINANSI or CP_WINUNICODE.
     #
     # *Returns*:: If the psz parameter specified a valid pointer, the return value is the length, in TCHARs, of the
     #             returned text (not including the terminating null character). If the psz parameter specified a NULL
@@ -884,11 +884,11 @@ module Win
     #
     # [*Syntax*] HDDEDATA DdeNameService( DWORD idInst, UINT hsz1, UINT hsz2, UINT afCmd );
     #
-    # idInst:: [in] Specifies the application instance identifier obtained by a previous call to the DdeInitialize.
-    # hsz1:: [in] Handle to the string that specifies the service name the server is registering or unregistering.
+    # idInst:: <in> Specifies the application instance identifier obtained by a previous call to the DdeInitialize.
+    # hsz1:: <in> Handle to the string that specifies the service name the server is registering or unregistering.
     #        An application that is unregistering all of its service names should set this parameter to 0L.
     # hsz2:: Reserved; should be set to 0L.
-    # afCmd:: [in] Specifies the service name options. This parameter can be one of the following values.
+    # afCmd:: <in> Specifies the service name options. This parameter can be one of the following values.
     #         DNS_REGISTER::  Registers the service name.
     #         DNS_UNREGISTER:: Unregisters the service name. If the hsz1 parameter is 0L,
     #                          all service names registered by the server will be unregistered.
@@ -930,15 +930,15 @@ module Win
     #
     # [*Syntax*] HCONV DdeConnect( DWORD idInst, HSZ hszService, HSZ hszTopic, PCONVCONTEXT pCC );
     #
-    # idInst::  [in] Specifies the application instance identifier obtained by a previous call to the DdeInitialize.
-    # hszService:: [in] Handle to the string that specifies the service name of the server application with which
+    # idInst::  <in> Specifies the application instance identifier obtained by a previous call to the DdeInitialize.
+    # hszService:: <in> Handle to the string that specifies the service name of the server application with which
     #              a conversation is to be established. This handle must have been created by a previous call to
     #              the DdeCreateStringHandle function. If this parameter is 0L, a conversation is established with
     #              any available server.
-    # hszTopic:: [in] Handle to the string that specifies the name of the topic on which a conversation is to be
+    # hszTopic:: <in> Handle to the string that specifies the name of the topic on which a conversation is to be
     #            established. This handle must have been created by a previous call to DdeCreateStringHandle.
     #            If this parameter is 0L, a conversation on any topic supported by the selected server is established.
-    # pCC:: [in] Pointer to the CONVCONTEXT structure that contains conversation context information. If this
+    # pCC:: <in> Pointer to the CONVCONTEXT structure that contains conversation context information. If this
     #            parameter is NULL, the server receives the default CONVCONTEXT structure during the XTYP_CONNECT
     #            or XTYP_WILDCONNECT transaction.
     # *Returns*:: If the function succeeds, the return value is the handle to the established conversation.
@@ -974,7 +974,7 @@ module Win
     #
     # [*Syntax*] BOOL DdeDisconnect( HCONV hConv );
     #
-    # hConv:: [in, out] Handle to the active conversation to be terminated.
+    # hConv:: <in, out> Handle to the active conversation to be terminated.
     #
     # *Returns*:: If the function succeeds, the return value is nonzero, otherwise zero. The DdeGetLastError function
     #             can be used to get the error code, which can be one of the following values:
@@ -1001,7 +1001,7 @@ module Win
     #
     # [*Syntax*] UINT DdeGetLastError( DWORD idInst );
     #
-    # idInst:: [in] Specifies the application instance identifier obtained by a previous call to the DdeInitialize.
+    # idInst:: <in> Specifies the application instance identifier obtained by a previous call to the DdeInitialize.
     #
     # *Returns*:: If the function succeeds, the return value is the last error code, which can be one of the following:
     # DMLERR_ADVACKTIMEOUT, DMLERR_EXECACKTIMEOUT, DMLERR_INVALIDPARAMETER, DMLERR_LOW_MEMORY, DMLERR_MEMORY_ERROR,
@@ -1024,27 +1024,27 @@ module Win
     # [*Syntax*]  HDDEDATA DdeClientTransaction( LPBYTE pData, DWORD cbData, HCONV hConv, HSZ hszItem, UINT
     #            wFmt, UINT wType, DWORD dwTimeout, LPDWORD pdwResult );
     #
-    # pData:: [in] Pointer to the beginning of the data the client must pass to the server.
+    # pData:: <in> Pointer to the beginning of the data the client must pass to the server.
     #         Optionally, an application can specify the data handle (HDDEDATA) to pass to the server and in that
     #         case the cbData parameter should be set to -1. This parameter is required only if the wType parameter
     #         is XTYP_EXECUTE or XTYP_POKE. Otherwise, this parameter should be NULL.
     #         For the optional usage of this parameter, XTYP_POKE transactions where pData is a data handle, the
     #         handle must have been created by a previous call to the DdeCreateDataHandle function, employing the
     #         same data format specified in the wFmt parameter.
-    # cbData:: [in] Specifies the length, in bytes, of the data pointed to by the pData parameter, including
+    # cbData:: <in> Specifies the length, in bytes, of the data pointed to by the pData parameter, including
     #          the terminating NULL, if the data is a string. A value of -1 indicates that pData is a data
     #          handle that identifies the data being sent.
-    # hConv:: [in] Handle to the conversation in which the transaction is to take place.
-    # hszItem:: [in] Handle to the data item for which data is being exchanged during the transaction. This
+    # hConv:: <in> Handle to the conversation in which the transaction is to take place.
+    # hszItem:: <in> Handle to the data item for which data is being exchanged during the transaction. This
     #           handle must have been created by a previous call to the DdeCreateStringHandle function. This
     #           parameter is ignored (and should be set to 0L) if the wType parameter is XTYP_EXECUTE.
-    # wFmt:: [in] Specifies the standard clipboard format in which the data item is being submitted or
+    # wFmt:: <in> Specifies the standard clipboard format in which the data item is being submitted or
     #        requested. If the transaction specified by the wType parameter does not pass data or is XTYP_EXECUTE,
     #        this parameter should be zero.
     #        If the transaction specified by the wType parameter references non-execute DDE data ( XTYP_POKE,
     #        XTYP_ADVSTART, XTYP_ADVSTOP, XTYP_REQUEST), the wFmt value must be either a valid predefined (CF_) DDE
     #        format or a valid registered clipboard format.
-    # wType:: [in] Specifies the transaction type. This parameter can be one of the following values.
+    # wType:: <in> Specifies the transaction type. This parameter can be one of the following values.
     #         - XTYP_ADVSTART: Begins an advise loop. Any number of distinct advise loops can exist within a
     #           conversation. An application can alter the advise loop type by combining the XTYP_ADVSTART
     #           transaction type with one or more of the following flags: Flag Meaning
@@ -1058,10 +1058,10 @@ module Win
     #         - XTYP_EXECUTE: Begins an execute transaction.
     #         - XTYP_POKE: Begins a poke transaction.
     #         - XTYP_REQUEST: Begins a request transaction.
-    # dwTimeout:: [in] Specifies the maximum amount of time, in milliseconds, that the client will wait for
+    # dwTimeout:: <in> Specifies the maximum amount of time, in milliseconds, that the client will wait for
     #             a response from the server application in a synchronous transaction. This parameter should
     #             be TIMEOUT_ASYNC for asynchronous transactions.
-    # pdwResult:: [out] Pointer to a variable that receives the result of the transaction. An application
+    # pdwResult:: <out> Pointer to a variable that receives the result of the transaction. An application
     #             that does not check the result can use NULL for this value. For synchronous transactions,
     #             the low-order word of this variable contains any applicable DDE_ flags resulting from the
     #             transaction. This provides support for applications dependent on DDE_APPSTATUS bits. It
@@ -1125,12 +1125,12 @@ module Win
     #
     # [*Syntax*] DWORD DdeGetData( HDDEDATA hData, LPBYTE pDst, DWORD cbMax, DWORD cbOff );
     #
-    # hData:: [in] Handle to the DDE object that contains the data to copy.
-    # pDst:: [out] Pointer to the buffer that receives the data. If this parameter is NULL, the DdeGetData
+    # hData:: <in> Handle to the DDE object that contains the data to copy.
+    # pDst:: <out> Pointer to the buffer that receives the data. If this parameter is NULL, the DdeGetData
     #        function returns the amount of data, in bytes, that would be copied to the buffer.
-    # cbMax:: [in] Specifies the maximum amount of data, in bytes, to copy to the buffer pointed to by the pDst
+    # cbMax:: <in> Specifies the maximum amount of data, in bytes, to copy to the buffer pointed to by the pDst
     #         parameter. Typically, this parameter specifies the length of the buffer pointed to by pDst.
-    # cbOff:: [in] Specifies an offset within the DDE object. Data is copied from the object beginning at this offset.
+    # cbOff:: <in> Specifies an offset within the DDE object. Data is copied from the object beginning at this offset.
     #
     # *Returns*:: If the pDst parameter points to a buffer, return value is the size, in bytes, of the memory object
     #             associated with the data handle or the size specified in the cbMax parameter, whichever is lower.
@@ -1171,8 +1171,8 @@ module Win
     #
     # [*Syntax*] LPBYTE DdeAccessData( HDDEDATA hData, LPDWORD pcbDataSize );
     #
-    # hData:: [in] Handle to the DDE object to access.
-    # pcbDataSize:: [out] Pointer to a variable that receives the size, in bytes, of the DDE object
+    # hData:: <in> Handle to the DDE object to access.
+    # pcbDataSize:: <out> Pointer to a variable that receives the size, in bytes, of the DDE object
     #               identified by the hData parameter. If this parameter is NULL, no size information is
     #               returned.
     #
@@ -1212,7 +1212,7 @@ module Win
       #
       # [*Syntax*] BOOL DdeUnaccessData( HDDEDATA hData );
       #
-      # hData:: [in] Handle to the DDE object.
+      # hData:: <in> Handle to the DDE object.
       #
       # *Returns*:: If the function succeeds, the return value is nonzero.
       # If the function fails, the return value is zero.

data/lib/win/error.rb

@@ -870,7 +870,7 @@ module Win
     # [*Syntax*] DWORD WINAPI FormatMessage( DWORD dwFlags, LPCVOID lpSource, DWORD dwMessageId, DWORD
     #            dwLanguageId, LPTSTR lpBuffer, DWORD nSize, va_list* Arguments );
     #
-    # dwFlags:: [in] The formatting options, and how to interpret the lpSource parameter. The low-order byte of dwFlags
+    # dwFlags:: <in> The formatting options, and how to interpret the lpSource parameter. The low-order byte of dwFlags
     #           specifies how the function handles line breaks in the output buffer. The low-order byte can also
     #           specify the maximum width of a formatted output line. Possible values:
     #           - FORMAT_MESSAGE_ALLOCATE_BUFFER - The lpBuffer parameter is a pointer to a PVOID pointer, and that
@@ -1075,7 +1075,7 @@ module Win
     #
     # [*Syntax*] void WINAPI SetLastError( DWORD dwErrCode );
     #
-    # dwErrCode:: [in] The last-error code for the thread.
+    # dwErrCode:: <in> The last-error code for the thread.
     #
     # *Returns*:: This function does not return a value.
     # ---

data/lib/win/gui/dialog.rb

@@ -14,8 +14,8 @@ module Win
       #
       # [*Syntax*]  HWND GetDlgItem( HWND hDlg, int nIDDlgItem );
       #
-      # hDlg:: [in] Handle to the dialog box that contains the control.
-      # nIDDlgItem:: [in] Specifies the identifier of the control to be retrieved.
+      # hDlg:: <in> Handle to the dialog box that contains the control.
+      # nIDDlgItem:: <in> Specifies the identifier of the control to be retrieved.
       # *Returns*:: If the function succeeds, the return value is the window handle of the specified control.
       #             If the function fails, the return value is NULL, indicating an invalid dialog box handle
       #             or a nonexistent control. To get extended error information, call GetLastError.

data/lib/win/gui/input.rb

@@ -139,13 +139,13 @@ module Win
       #
       # [*Syntax*] VOID keybd_event( BYTE bVk, BYTE bScan, DWORD dwFlags, PTR dwExtraInfo);
       #
-      # bVk:: [in] Specifies a virtual-key code. The code must be a value in the range 1 to 254.
+      # bVk:: <in> Specifies a virtual-key code. The code must be a value in the range 1 to 254.
       #       For a complete list, see Virtual-Key Codes.
-      # bScan:: [in] Specifies a hardware scan code for the key.
-      # dwFlags:: [in] Specifies various aspects of function operation. This parameter can be
+      # bScan:: <in> Specifies a hardware scan code for the key.
+      # dwFlags:: <in> Specifies various aspects of function operation. This parameter can be
       #           one or more of the following values:
       #           KEYEVENTF_EXTENDEDKEY, KEYEVENTF_KEYUP, KEYEVENTF_KEYDOWN
-      # dwExtraInfo:: [in] Specifies an additional value associated with the key stroke.
+      # dwExtraInfo:: <in> Specifies an additional value associated with the key stroke.
       #
       # <b>NO Return Value</b>
       # ---
@@ -168,7 +168,7 @@ module Win
       #
       # [*Syntax*]  VOID mouse_event( DWORD dwFlags, DWORD dx, DWORD dy, DWORD dwData, ULONG_PTR dwExtraInfo );
       #
-      # dwFlags:: [in] Specifies various aspects of mouse motion and button clicking. This parameter can be certain
+      # dwFlags:: <in> Specifies various aspects of mouse motion and button clicking. This parameter can be certain
       #           combinations of the following values. The values that specify mouse button status are set to indicate
       #           changes in status, not ongoing conditions. For example, if the left mouse button is pressed and
       #           held down, MOUSEEVENTF_LEFTDOWN is set when the left button is first pressed, but not for subsequent
@@ -178,14 +178,14 @@ module Win
       #           MOUSEEVENTF_ABSOLUTE, MOUSEEVENTF_MOVE, MOUSEEVENTF_LEFTDOWN, MOUSEEVENTF_LEFTUP,
       #           MOUSEEVENTF_RIGHTDOWN, MOUSEEVENTF_RIGHTUP, MOUSEEVENTF_MIDDLEDOWN, MOUSEEVENTF_MIDDLEUP,
       #           MOUSEEVENTF_WHEEL, MOUSEEVENTF_XDOWN, MOUSEEVENTF_XUP
-      # dx:: [in] Specifies the mouse's absolute position along the x-axis or its amount of motion since the
+      # dx:: <in> Specifies the mouse's absolute position along the x-axis or its amount of motion since the
       #      last mouse event was generated, depending on the setting of MOUSEEVENTF_ABSOLUTE. Absolute data is
       #      specified as the mouse's actual x-coordinate; relative data is specified as the number of mickeys moved.
       #      A mickey is the amount that a mouse has to move for it to report that it has moved.
-      # dy:: [in] Specifies the mouse's absolute position along the y-axis or its amount of motion since the
+      # dy:: <in> Specifies the mouse's absolute position along the y-axis or its amount of motion since the
       #      last mouse event was generated, depending on the setting of MOUSEEVENTF_ABSOLUTE. Absolute data is
       #      specified as the mouse's actual y-coordinate; relative data is specified as the number of mickeys moved.
-      # dwData:: [in]
+      # dwData:: <in>
       #          - If dwFlags contains MOUSEEVENTF_WHEEL, then data specifies the amount of wheel movement.
       #            A positive value indicates that the wheel was rotated forward, away from the user; a negative value
       #            indicates that the wheel was rotated backward, toward the user. One wheel click is defined as
@@ -198,7 +198,7 @@ module Win
       #          - If flags is not MOUSEEVENTF_WHEEL, MOUSEEVENTF_XDOWN, or MOUSEEVENTF_XUP, then data should be zero.
       #          XBUTTON1 - Set if the first X button was pressed or released.
       #          XBUTTON2 - Set if the second X button was pressed or released.
-      # dwExtraInfo:: [in] Specifies an additional value associated with the mouse event. An application
+      # dwExtraInfo:: <in> Specifies an additional value associated with the mouse event. An application
       #               calls GetMessageExtraInfo to obtain this extra information.
       # <b>NO Return Value</b>
       # ---
@@ -245,8 +245,8 @@ module Win
       #
       # [*Syntax*] BOOL SetCursorPos( int X, int Y );
       #
-      # X:: [in] Specifies the new x-coordinate of the cursor, in screen coordinates.
-      # Y:: [in] Specifies the new y-coordinate of the cursor, in screen coordinates.
+      # X:: <in> Specifies the new x-coordinate of the cursor, in screen coordinates.
+      # Y:: <in> Specifies the new y-coordinate of the cursor, in screen coordinates.
       #
       # *Returns*:: Nonzero(*true*) if successful or zero(*false*) otherwise. To get extended error information,
       #             call GetLastError. Enhanced to return true/false instead of nonzero/zero
@@ -267,7 +267,7 @@ module Win
       #
       # [*Syntax*]  BOOL GetCursorPos( LPPOINT lpPoint );
       #
-      # lpPoint:: [out] Pointer to a POINT structure that receives the screen coordinates of the cursor.
+      # lpPoint:: <out> Pointer to a POINT structure that receives the screen coordinates of the cursor.
       #
       # *Returns*:: Returns nonzero if successful or zero otherwise. To get extended error information, call
       #             GetLastError.

data/lib/win/gui/message.rb

@@ -342,12 +342,12 @@ module Win
       #
       # [*Syntax*] VOID SendAsyncProc( HWND hwnd, UINT uMsg, ULONG_PTR dwData, LRESULT lResult );
       #
-      # hwnd:: [in] Handle to the window whose window procedure received the message. If SendMessageCallback
+      # hwnd:: <in> Handle to the window whose window procedure received the message. If SendMessageCallback
       #        function was called with its hwnd parameter set to HWND_BROADCAST, the system calls the
       #        SendAsyncProc function once for each top-level window.
-      # uMsg:: [in] Specifies the message.
-      # dwData:: [in] Specifies an application-defined value sent from the SendMessageCallback function.
-      # lResult:: [in] Specifies the result of the message processing. This value depends on the message.
+      # uMsg:: <in> Specifies the message.
+      # dwData:: <in> Specifies an application-defined value sent from the SendMessageCallback function.
+      # lResult:: <in> Specifies the result of the message processing. This value depends on the message.
       #
       # :call-seq:
       #  SendAsyncProc callback block: {|handle, msg, data, l_result| your callback code }
@@ -363,16 +363,16 @@ module Win
       #  [*Syntax*] BOOL SendMessageCallback( HWND hWnd, UINT Msg, WPARAM wParam, LPARAM lParam,
       #             SENDASYNCPROC lpCallBack, ULONG_PTR dwData);
       #
-      #  hWnd:: [in] Handle to the window whose window procedure will receive the message. If this parameter is
+      #  hWnd:: <in> Handle to the window whose window procedure will receive the message. If this parameter is
       #         HWND_BROADCAST, the message is sent to all top-level windows in the system, including disabled or
       #         invisible, unowned, overlapped and pop-up windows; but the message is not sent to child windows.
-      #  Msg:: [in] Specifies the message to be sent.
-      #  wParam:: [in] Specifies additional message-specific information.
-      #  lParam:: [in] Specifies additional message-specific information.
-      #  lpCallBack:: [in] Pointer to a callback function that the system calls after the window procedure processes
+      #  Msg:: <in> Specifies the message to be sent.
+      #  wParam:: <in> Specifies additional message-specific information.
+      #  lParam:: <in> Specifies additional message-specific information.
+      #  lpCallBack:: <in> Pointer to a callback function that the system calls after the window procedure processes
       #               the message. For more information, see SendAsyncProc. If hWnd is HWND_BROADCAST, the system calls
       #               SendAsyncProc callback function once for each top-level window.
-      #  dwData:: [in] Specifies an application-defined value to be sent to the callback function pointed to by
+      #  dwData:: <in> Specifies an application-defined value to be sent to the callback function pointed to by
       #           the lpCallBack parameter.
       #  *Returns*:: Nonzero if the function succeeds, zero if it fails. For extended error info, call GetLastError.
       #  ---
@@ -404,14 +404,14 @@ module Win
       #
       # [*Syntax*] BOOL PostMessage( HWND hWnd, UINT Msg, WPARAM wParam, LPARAM lParam);
       #
-      # hWnd::   [in] Handle to the window whose window procedure will receive the message. If this parameter is
+      # hWnd::   <in> Handle to the window whose window procedure will receive the message. If this parameter is
       #          HWND_BROADCAST, the message is sent to all top-level windows in the system, including disabled or
       #          invisible unowned windows, overlapped windows, and pop-up windows; but the message is not posted to
       #          child windows. If it is NULL, the function behaves like a call to PostThreadMessage()
       #          with the dwThreadId parameter set to the identifier of the current thread.
-      # Msg:: [in] Specifies the message to be posted.
-      # wParam:: [in] Specifies additional message-specific information.
-      # lParam:: [in] Specifies additional message-specific information.
+      # Msg:: <in> Specifies the message to be posted.
+      # wParam:: <in> Specifies additional message-specific information.
+      # lParam:: <in> Specifies additional message-specific information.
       #
       # *Returns*:: Nonzero if the function succeeds, zero if it fails. For extended error info, call GetLastError.
       # ---
@@ -444,16 +444,16 @@ module Win
       #
       # [*Syntax*] LRESULT SendMessage( HWND hWnd, UINT Msg, WPARAM wParam, LPARAM lParam );
       #
-      # hWnd:: [in] Handle to the window whose window procedure will receive the message. If this parameter is
+      # hWnd:: <in> Handle to the window whose window procedure will receive the message. If this parameter is
       #        HWND_BROADCAST, the message is sent to all top-level windows in the system, including disabled or
       #        invisible unowned windows, overlapped windows, and pop-up windows; but the message is not sent to
       #        child windows.
       #        Microsoft Windows Vista and later. Message sending is subject to User Interface Privilege Isolation
       #        (UIPI). The thread of a process can send messages only to message queues of threads in processes of
       #        lesser or equal integrity level.
-      # Msg:: [in] Specifies the message to be sent.
-      # wParam:: [in] Specifies additional message-specific information.
-      # lParam:: [in/out?] Specifies additional message-specific information.
+      # Msg:: <in> Specifies the message to be sent.
+      # wParam:: <in> Specifies additional message-specific information.
+      # lParam:: <in/out?> Specifies additional message-specific information.
       #
       # *Return*:: The return value specifies the result of the message processing; it depends on the message sent.
       # ---
@@ -512,21 +512,21 @@ module Win
       #
       # [*Syntax*]  BOOL GetMessage( LPMSG lpMsg, HWND hWnd, UINT wMsgFilterMin, UINT wMsgFilterMax );
       #
-      # lpMsg:: [out] Pointer to an MSG structure that receives message information from the thread's message
+      # lpMsg:: <out> Pointer to an MSG structure that receives message information from the thread's message
       #         queue.
-      # hWnd:: [in] Handle to the window whose messages are to be retrieved. The window must belong to the current
+      # hWnd:: <in> Handle to the window whose messages are to be retrieved. The window must belong to the current
       #        thread. If hWnd is NULL, GetMessage retrieves messages for any window that belongs to the current
       #        thread, and any messages on the current thread's message queue whose hwnd value is NULL (see the MSG
       #        structure). Therefore if hWnd is NULL, both window messages and thread messages are processed.
       #        If hWnd is -1, GetMessage retrieves only messages on the current thread's message queue whose hwnd
       #        value is NULL, that is, thread messages as posted by PostMessage (when the hWnd parameter is NULL) or
       #        PostThreadMessage.
-      # wMsgFilterMin:: [in] Specifies the integer value of the lowest message value to be retrieved. Use WM_KEYFIRST
+      # wMsgFilterMin:: <in> Specifies the integer value of the lowest message value to be retrieved. Use WM_KEYFIRST
       #                 to specify the first keyboard message or WM_MOUSEFIRST to specify the first mouse message.
       #                 Windows XP: Use WM_INPUT here and in wMsgFilterMax to specify only the WM_INPUT messages.
       #                 If wMsgFilterMin and wMsgFilterMax are both zero, GetMessage returns all available messages
       #                 (that is, no range filtering is performed).
-      # wMsgFilterMax:: [in] Specifies the integer value of the highest message value to be retrieved. Use
+      # wMsgFilterMax:: <in> Specifies the integer value of the highest message value to be retrieved. Use
       #                 WM_KEYLAST to specify the last keyboard message or WM_MOUSELAST to specify the last
       #                 mouse message.
       #
@@ -606,22 +606,22 @@ module Win
       # [*Syntax*]  BOOL PeekMessage( LPMSG lpMsg, HWND hWnd, UINT wMsgFilterMin, UINT wMsgFilterMax,
       #                               UINT wRemoveMsg );
       #
-      # lpMsg:: [out] Pointer to an MSG structure that receives message information.
-      # hWnd:: [in] Handle to the window whose messages are to be retrieved. The window must belong to the current
+      # lpMsg:: <out> Pointer to an MSG structure that receives message information.
+      # hWnd:: <in> Handle to the window whose messages are to be retrieved. The window must belong to the current
       #        thread. If hWnd is NULL, PeekMessage retrieves messages for any window that belongs to the current
       #        thread, and any messages on the current thread's message queue whose hwnd value is NULL (see MSG).
       #        Therefore if hWnd is NULL, both window messages and thread messages are processed.
       #        If hWnd is -1, PeekMessage retrieves only messages on the current thread's message queue whose hwnd
       #        value is NULL, that is, thread messages as posted by PostMessage (when the hWnd parameter is NULL) or
       #        PostThreadMessage.
-      # wMsgFilterMin:: [in] Specifies the value of the first message in the range of messages to be examined.
+      # wMsgFilterMin:: <in> Specifies the value of the first message in the range of messages to be examined.
       #                 Use WM_KEYFIRST to specify the first keyboard message or WM_MOUSEFIRST to specify the
       #                 first mouse message. If wMsgFilterMin and wMsgFilterMax are both zero, PeekMessage returns all
       #                 available messages (that is, no range filtering is performed).
-      # wMsgFilterMax:: [in] Specifies the value of the last message in the range of messages to be examined.
+      # wMsgFilterMax:: <in> Specifies the value of the last message in the range of messages to be examined.
       #                 Use WM_KEYLAST to specify the last keyboard message or WM_MOUSELAST to specify the
       #                 last mouse message.
-      # wRemoveMsg:: [in] Specifies how messages are handled. This parameter can be one of the following values.
+      # wRemoveMsg:: <in> Specifies how messages are handled. This parameter can be one of the following values.
       #              - PM_NOREMOVE - Messages are not removed from the queue after processing by PeekMessage.
       #              - PM_REMOVE - Messages are removed from the queue after processing by PeekMessage.
       #              You can optionally combine the value PM_NOYIELD with either PM_NOREMOVE or PM_REMOVE. This flag
@@ -687,7 +687,7 @@ module Win
       #
       # [*Syntax*]  BOOL TranslateMessage( const MSG *lpMsg );
       #
-      # lpMsg:: [in] Pointer to an MSG structure that contains message information retrieved from the calling
+      # lpMsg:: <in> Pointer to an MSG structure that contains message information retrieved from the calling
       #         thread's message queue by using the GetMessage or PeekMessage function.
       #
       # *Returns*:: If the message is translated (that is, a character message is posted to the thread's
@@ -726,7 +726,7 @@ module Win
       #
       # [*Syntax*] LRESULT DispatchMessage( const MSG *lpmsg );
       #
-      # lpmsg:: [in] Pointer to an MSG structure that contains the message.
+      # lpmsg:: <in> Pointer to an MSG structure that contains the message.
       #
       # *Returns*:: The return value specifies the value returned by the window procedure. Although its
       #             meaning depends on the message being dispatched, the return value generally is ignored.