Skip to content

Commit 2c5d193

Browse files
committed
[DOC] Update class names using the scoped names
1 parent 5feede2 commit 2c5d193

File tree

9 files changed

+353
-342
lines changed

9 files changed

+353
-342
lines changed

ext/win32ole/win32ole.c

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1962,7 +1962,7 @@ ole_bind_obj(VALUE moniker, int argc, VALUE *argv, VALUE self)
19621962

19631963
/*
19641964
* call-seq:
1965-
* WIN32OLE.connect( ole ) --> aWIN32OLE
1965+
* connect( ole ) --> aWIN32OLE
19661966
*
19671967
* Returns running OLE Automation object or WIN32OLE object from moniker.
19681968
* 1st argument should be OLE program id or class id or moniker.
@@ -2019,7 +2019,7 @@ fole_s_connect(int argc, VALUE *argv, VALUE self)
20192019

20202020
/*
20212021
* call-seq:
2022-
* WIN32OLE.const_load( ole, mod = WIN32OLE)
2022+
* const_load( ole, mod = WIN32OLE)
20232023
*
20242024
* Defines the constants of OLE Automation server as mod's constants.
20252025
* The first argument is WIN32OLE object or type library name.
@@ -2124,7 +2124,7 @@ reference_count(struct oledata * pole)
21242124

21252125
/*
21262126
* call-seq:
2127-
* WIN32OLE.ole_reference_count(aWIN32OLE) --> number
2127+
* ole_reference_count(aWIN32OLE) --> number
21282128
*
21292129
* Returns reference counter of Dispatch interface of WIN32OLE object.
21302130
* You should not use this method because this method
@@ -2140,7 +2140,7 @@ fole_s_reference_count(VALUE self, VALUE obj)
21402140

21412141
/*
21422142
* call-seq:
2143-
* WIN32OLE.ole_free(aWIN32OLE) --> number
2143+
* ole_free(aWIN32OLE) --> number
21442144
*
21452145
* Invokes Release method of Dispatch interface of WIN32OLE object.
21462146
* You should not use this method because this method
@@ -2184,10 +2184,10 @@ ole_show_help(VALUE helpfile, VALUE helpcontext)
21842184

21852185
/*
21862186
* call-seq:
2187-
* WIN32OLE.ole_show_help(obj [,helpcontext])
2187+
* ole_show_help(obj [,helpcontext])
21882188
*
2189-
* Displays helpfile. The 1st argument specifies WIN32OLE_TYPE
2190-
* object or WIN32OLE_METHOD object or helpfile.
2189+
* Displays helpfile. The 1st argument specifies WIN32OLE::Type
2190+
* object or WIN32OLE::Method object or helpfile.
21912191
*
21922192
* excel = WIN32OLE.new('Excel.Application')
21932193
* typeobj = excel.ole_type
@@ -2227,7 +2227,7 @@ fole_s_show_help(int argc, VALUE *argv, VALUE self)
22272227

22282228
/*
22292229
* call-seq:
2230-
* WIN32OLE.codepage
2230+
* codepage
22312231
*
22322232
* Returns current codepage.
22332233
* WIN32OLE.codepage # => WIN32OLE::CP_ACP
@@ -2258,7 +2258,7 @@ code_page_installed(UINT cp)
22582258

22592259
/*
22602260
* call-seq:
2261-
* WIN32OLE.codepage = CP
2261+
* codepage = CP
22622262
*
22632263
* Sets current codepage.
22642264
* The WIN32OLE.codepage is initialized according to
@@ -2282,7 +2282,7 @@ fole_s_set_code_page(VALUE self, VALUE vcp)
22822282

22832283
/*
22842284
* call-seq:
2285-
* WIN32OLE.locale -> locale id.
2285+
* locale -> locale id.
22862286
*
22872287
* Returns current locale id (lcid). The default locale is
22882288
* WIN32OLE::LOCALE_SYSTEM_DEFAULT.
@@ -2316,12 +2316,12 @@ lcid_installed(LCID lcid)
23162316

23172317
/*
23182318
* call-seq:
2319-
* WIN32OLE.locale = lcid
2319+
* locale = lcid
23202320
*
23212321
* Sets current locale id (lcid).
23222322
*
23232323
* WIN32OLE.locale = 1033 # set locale English(U.S)
2324-
* obj = WIN32OLE_VARIANT.new("$100,000", WIN32OLE::VARIANT::VT_CY)
2324+
* obj = WIN32OLE::Variant.new("$100,000", WIN32OLE::VARIANT::VT_CY)
23252325
*
23262326
*/
23272327
static VALUE
@@ -2345,7 +2345,7 @@ fole_s_set_locale(VALUE self, VALUE vlcid)
23452345

23462346
/*
23472347
* call-seq:
2348-
* WIN32OLE.create_guid
2348+
* create_guid
23492349
*
23502350
* Creates GUID.
23512351
* WIN32OLE.create_guid # => {1CB530F1-F6B1-404D-BCE6-1959BF91F4A8}
@@ -2393,9 +2393,9 @@ fole_s_ole_uninitialize(VALUE self)
23932393
/*
23942394
* Document-class: WIN32OLE
23952395
*
2396-
* <code>WIN32OLE</code> objects represent OLE Automation object in Ruby.
2396+
* +WIN32OLE+ objects represent OLE Automation object in Ruby.
23972397
*
2398-
* By using WIN32OLE, you can access OLE server like VBScript.
2398+
* By using +WIN32OLE+, you can access OLE server like VBScript.
23992399
*
24002400
* Here is sample script.
24012401
*
@@ -2419,18 +2419,18 @@ fole_s_ole_uninitialize(VALUE self)
24192419
* excel.ActiveWorkbook.Close(0);
24202420
* excel.Quit();
24212421
*
2422-
* Unfortunately, Win32OLE doesn't support the argument passed by
2422+
* Unfortunately, +WIN32OLE+ doesn't support the argument passed by
24232423
* reference directly.
2424-
* Instead, Win32OLE provides WIN32OLE::ARGV or WIN32OLE_VARIANT object.
2424+
* Instead, +WIN32OLE+ provides WIN32OLE::ARGV or WIN32OLE::Variant object.
24252425
* If you want to get the result value of argument passed by reference,
2426-
* you can use WIN32OLE::ARGV or WIN32OLE_VARIANT.
2426+
* you can use WIN32OLE::ARGV or WIN32OLE::Variant.
24272427
*
24282428
* oleobj.method(arg1, arg2, refargv3)
24292429
* puts WIN32OLE::ARGV[2] # the value of refargv3 after called oleobj.method
24302430
*
24312431
* or
24322432
*
2433-
* refargv3 = WIN32OLE_VARIANT.new(XXX,
2433+
* refargv3 = WIN32OLE::Variant.new(XXX,
24342434
* WIN32OLE::VARIANT::VT_BYREF|WIN32OLE::VARIANT::VT_XXX)
24352435
* oleobj.method(arg1, arg2, refargv3)
24362436
* p refargv3.value # the value of refargv3 after called oleobj.method.
@@ -2439,7 +2439,7 @@ fole_s_ole_uninitialize(VALUE self)
24392439

24402440
/*
24412441
* call-seq:
2442-
* WIN32OLE.new(server, [host]) -> WIN32OLE object
2442+
* new(server, [host]) -> WIN32OLE object
24432443
* WIN32OLE.new(server, license: 'key') -> WIN32OLE object
24442444
*
24452445
* Returns a new WIN32OLE object(OLE Automation object).
@@ -2826,7 +2826,7 @@ ole_invoke(int argc, VALUE *argv, VALUE self, USHORT wFlags, BOOL is_bracket)
28262826

28272827
/*
28282828
* call-seq:
2829-
* WIN32OLE#invoke(method, [arg1,...]) => return value of method.
2829+
* invoke(method, [arg1,...]) => return value of method.
28302830
*
28312831
* Runs OLE method.
28322832
* The first argument specifies the method name of OLE Automation object.
@@ -3038,7 +3038,7 @@ ole_invoke2(VALUE self, VALUE dispid, VALUE args, VALUE types, USHORT dispkind)
30383038

30393039
/*
30403040
* call-seq:
3041-
* WIN32OLE#_invoke(dispid, args, types)
3041+
* _invoke(dispid, args, types)
30423042
*
30433043
* Runs the early binding method.
30443044
* The 1st argument specifies dispatch ID,
@@ -3056,7 +3056,7 @@ fole_invoke2(VALUE self, VALUE dispid, VALUE args, VALUE types)
30563056

30573057
/*
30583058
* call-seq:
3059-
* WIN32OLE#_getproperty(dispid, args, types)
3059+
* _getproperty(dispid, args, types)
30603060
*
30613061
* Runs the early binding method to get property.
30623062
* The 1st argument specifies dispatch ID,
@@ -3074,7 +3074,7 @@ fole_getproperty2(VALUE self, VALUE dispid, VALUE args, VALUE types)
30743074

30753075
/*
30763076
* call-seq:
3077-
* WIN32OLE#_setproperty(dispid, args, types)
3077+
* _setproperty(dispid, args, types)
30783078
*
30793079
* Runs the early binding method to set property.
30803080
* The 1st argument specifies dispatch ID,
@@ -3120,7 +3120,7 @@ fole_setproperty_with_bracket(int argc, VALUE *argv, VALUE self)
31203120

31213121
/*
31223122
* call-seq:
3123-
* WIN32OLE.setproperty('property', [arg1, arg2,...] val)
3123+
* setproperty('property', [arg1, arg2,...] val)
31243124
*
31253125
* Sets property of OLE object.
31263126
* When you want to set property with argument, you can use this method.
@@ -3226,7 +3226,7 @@ ole_propertyput(VALUE self, VALUE property, VALUE value)
32263226

32273227
/*
32283228
* call-seq:
3229-
* WIN32OLE#ole_free
3229+
* ole_free
32303230
*
32313231
* invokes Release method of Dispatch interface of WIN32OLE object.
32323232
* Usually, you do not need to call this method because Release method
@@ -3269,7 +3269,7 @@ ole_ienum_free(VALUE pEnumV)
32693269

32703270
/*
32713271
* call-seq:
3272-
* WIN32OLE#each {|i|...}
3272+
* each {|i|...}
32733273
*
32743274
* Iterates over each item of OLE collection which has IEnumVARIANT interface.
32753275
*
@@ -3340,7 +3340,7 @@ fole_each(VALUE self)
33403340

33413341
/*
33423342
* call-seq:
3343-
* WIN32OLE#method_missing(id [,arg1, arg2, ...])
3343+
* method_missing(id [,arg1, arg2, ...])
33443344
*
33453345
* Calls WIN32OLE#invoke method.
33463346
*/
@@ -3438,9 +3438,9 @@ ole_methods(VALUE self, int mask)
34383438

34393439
/*
34403440
* call-seq:
3441-
* WIN32OLE#ole_methods
3441+
* ole_methods
34423442
*
3443-
* Returns the array of WIN32OLE_METHOD object.
3443+
* Returns the array of WIN32OLE::Method object.
34443444
* The element is OLE method of WIN32OLE object.
34453445
*
34463446
* excel = WIN32OLE.new('Excel.Application')
@@ -3455,9 +3455,9 @@ fole_methods(VALUE self)
34553455

34563456
/*
34573457
* call-seq:
3458-
* WIN32OLE#ole_get_methods
3458+
* ole_get_methods
34593459
*
3460-
* Returns the array of WIN32OLE_METHOD object .
3460+
* Returns the array of WIN32OLE::Method object .
34613461
* The element of the array is property (gettable) of WIN32OLE object.
34623462
*
34633463
* excel = WIN32OLE.new('Excel.Application')
@@ -3471,9 +3471,9 @@ fole_get_methods(VALUE self)
34713471

34723472
/*
34733473
* call-seq:
3474-
* WIN32OLE#ole_put_methods
3474+
* ole_put_methods
34753475
*
3476-
* Returns the array of WIN32OLE_METHOD object .
3476+
* Returns the array of WIN32OLE::Method object .
34773477
* The element of the array is property (settable) of WIN32OLE object.
34783478
*
34793479
* excel = WIN32OLE.new('Excel.Application')
@@ -3487,9 +3487,9 @@ fole_put_methods(VALUE self)
34873487

34883488
/*
34893489
* call-seq:
3490-
* WIN32OLE#ole_func_methods
3490+
* ole_func_methods
34913491
*
3492-
* Returns the array of WIN32OLE_METHOD object .
3492+
* Returns the array of WIN32OLE::Method object .
34933493
* The element of the array is property (settable) of WIN32OLE object.
34943494
*
34953495
* excel = WIN32OLE.new('Excel.Application')
@@ -3504,9 +3504,9 @@ fole_func_methods(VALUE self)
35043504

35053505
/*
35063506
* call-seq:
3507-
* WIN32OLE#ole_type
3507+
* ole_type
35083508
*
3509-
* Returns WIN32OLE_TYPE object.
3509+
* Returns WIN32OLE::Type object.
35103510
*
35113511
* excel = WIN32OLE.new('Excel.Application')
35123512
* tobj = excel.ole_type
@@ -3536,9 +3536,9 @@ fole_type(VALUE self)
35363536

35373537
/*
35383538
* call-seq:
3539-
* WIN32OLE#ole_typelib -> The WIN32OLE_TYPELIB object
3539+
* ole_typelib -> The WIN32OLE_TYPELIB object
35403540
*
3541-
* Returns the WIN32OLE_TYPELIB object. The object represents the
3541+
* Returns the WIN32OLE::TypeLib object. The object represents the
35423542
* type library which contains the WIN32OLE object.
35433543
*
35443544
* excel = WIN32OLE.new('Excel.Application')
@@ -3570,7 +3570,7 @@ fole_typelib(VALUE self)
35703570

35713571
/*
35723572
* call-seq:
3573-
* WIN32OLE#ole_query_interface(iid) -> WIN32OLE object
3573+
* ole_query_interface(iid) -> WIN32OLE object
35743574
*
35753575
* Returns WIN32OLE object for a specific dispatch or dual
35763576
* interface specified by iid.
@@ -3616,7 +3616,7 @@ fole_query_interface(VALUE self, VALUE str_iid)
36163616

36173617
/*
36183618
* call-seq:
3619-
* WIN32OLE#ole_respond_to?(method) -> true or false
3619+
* ole_respond_to?(method) -> true or false
36203620
*
36213621
* Returns true when OLE object has OLE method, otherwise returns false.
36223622
*
@@ -3825,9 +3825,9 @@ ole_typedesc2val(ITypeInfo *pTypeInfo, TYPEDESC *pTypeDesc, VALUE typedetails)
38253825

38263826
/*
38273827
* call-seq:
3828-
* WIN32OLE#ole_method_help(method)
3828+
* ole_method_help(method)
38293829
*
3830-
* Returns WIN32OLE_METHOD object corresponding with method
3830+
* Returns WIN32OLE::Method object corresponding with method
38313831
* specified by 1st argument.
38323832
*
38333833
* excel = WIN32OLE.new('Excel.Application')
@@ -3859,7 +3859,7 @@ fole_method_help(VALUE self, VALUE cmdname)
38593859

38603860
/*
38613861
* call-seq:
3862-
* WIN32OLE#ole_activex_initialize() -> Qnil
3862+
* ole_activex_initialize() -> Qnil
38633863
*
38643864
* Initialize WIN32OLE object(ActiveX Control) by calling
38653865
* IPersistMemory::InitNew.
@@ -4073,7 +4073,7 @@ Init_win32ole(void)
40734073
* p c # => 0
40744074
* p WIN32OLE::ARGV # => [10, 20, 30]
40754075
*
4076-
* You can use WIN32OLE_VARIANT object to retrieve the value of reference
4076+
* You can use WIN32OLE::Variant object to retrieve the value of reference
40774077
* arguments instead of referring WIN32OLE::ARGV.
40784078
*
40794079
*/

0 commit comments

Comments
 (0)