Bug #5192

[documentation] 100% of Fiddle and +12% of DL

Added by Vincent Batts almost 3 years ago. Updated almost 3 years ago.

[ruby-core:38960]
Status:Closed
Priority:Normal
Assignee:Eric Hodel
Category:doc
Target version:1.9.3
ruby -v:ruby 1.9.3dev (2011-08-15 revision 32976) [x86_64-linux] Backport:

Description

The two attached patches, include the documentation for the following

--- 1.xx 2011-08-15 00:33:23.984573861 -0400
+++ 2.xx 2011-08-15 00:33:36.404573862 -0400
@@ -1,8 +1,102 @@

The following items are not documented:

-module DL # is documented
+# in files:
+# callback/callback.c
+# cfunc.c
+# cptr.c
+# lib/dl.rb
+# lib/dl/stack.rb
+# lib/dl/cparser.rb
+# lib/dl/value.rb
+# lib/dl/func.rb
+# lib/dl/callback.rb
+# lib/dl/types.rb
+# lib/dl/struct.rb
+# lib/dl/import.rb
+# lib/dl/pack.rb
+# dl.c

+module DL
+
+ # in file callback/callback.c
+ CdeclCallbackProcs = nil
+ # in file callback/callback.c
+ CdeclCallbackAddrs = nil
+ # in file callback/callback.c
+ StdcallCallbackProcs = nil
+ # in file callback/callback.c
+ StdcallCallbackAddrs = nil
+ # in file cptr.c
+ NULL = nil
+ # in file lib/dl/callback.rb
+ SEM = nil
+ # in file dl.c
+ MAX_CALLBACK = nil
+ # in file dl.c
+ DLSTACK_SIZE = nil
+ # in file dl.c
+ RTLD_GLOBAL = nil
+ # in file dl.c
+ RTLD_LAZY = nil
+ # in file dl.c
+ RTLD_NOW = nil
+ # in file dl.c
+ TYPE_VOID = nil
+ # in file dl.c
+ TYPE_VOIDP = nil
+ # in file dl.c
+ TYPE_CHAR = nil
+ # in file dl.c
+ TYPE_SHORT = nil
+ # in file dl.c
+ TYPE_INT = nil
+ # in file dl.c
+ TYPE_LONG = nil
+ # in file dl.c
+ TYPE_LONG_LONG = nil
+ # in file dl.c
+ TYPE_FLOAT = nil
+ # in file dl.c
+ TYPE_DOUBLE = nil
+ # in file dl.c
+ ALIGN_VOIDP = nil
+ # in file dl.c
+ ALIGN_CHAR = nil
+ # in file dl.c
+ ALIGN_SHORT = nil
+ # in file dl.c
+ ALIGN_INT = nil
+ # in file dl.c
+ ALIGN_LONG = nil
+ # in file dl.c
+ ALIGN_LONG_LONG = nil
+ # in file dl.c
+ ALIGN_FLOAT = nil
+ # in file dl.c
+ ALIGN_DOUBLE = nil
+ # in file dl.c
+ SIZEOF_VOIDP = nil
+ # in file dl.c
+ SIZEOF_CHAR = nil
+ # in file dl.c
+ SIZEOF_SHORT = nil
+ # in file dl.c
+ SIZEOF_INT = nil
+ # in file dl.c
+ SIZEOF_LONG = nil
+ # in file dl.c
+ SIZEOF_LONG_LONG = nil
+ # in file dl.c
+ SIZEOF_FLOAT = nil
+ # in file dl.c
+ SIZEOF_DOUBLE = nil
+ # in file dl.c
+ RUBY_FREE = nil
+ # in file dl.c
+ BUILD_RUBY_PLATFORM = nil
+ # in file dl.c
+ BUILD_RUBY_VERSION = nil
# in file dl.c
def dlopen(*args); end

@@ -41,7 +135,31 @@

end

+# in files:
+# lib/dl/types.rb
+
+module DL::BasicTypes
+
+ # in file lib/dl/types.rb
+ def included(m); end
+
+ # in file lib/dl/types.rb
+ def included(m); end
+
+end
+
+# in files:
+# cfunc.c
+
+class DL::CFunc
+
+ # in file cfunc.c
+ def last_error(); end

  • # in file cfunc.c
  • def win32_last_error(); end
    +
    +end

    in files:

    lib/dl/cparser.rb

    @@ -59,6 +177,11 @@

    end

+# in files:
+# cfunc.c
+
+class DL::CPtr
+end

# in files:
# lib/dl/struct.rb
@@ -166,7 +289,17 @@

end

+# in files:
+# cfunc.c
+
+class DL::DLError
+end
+
+# in files:
+# cfunc.c

+class DL::DLTypeError
+end

# in files:
# lib/dl/func.rb
@@ -205,8 +338,21 @@

end

+# in files:
+# cfunc.c

-module DL::Importer # is documented
+class DL::Handle
+
+ # in file handle.c
+ NEXT = nil
+ # in file handle.c
+ DEFAULT = nil
+end
+
+# in files:
+# lib/dl/import.rb
+
+module DL::Importer

# in file lib/dl/import.rb
def ; end
@@ -380,6 +526,18 @@

end

+# in files:
+# lib/dl/types.rb
+
+module DL::Win32Types
+
+ # in file lib/dl/types.rb
+ def included(m); end
+
+ # in file lib/dl/types.rb
+ def included(m); end
+
+end

# in files:
# callback/mkcallback.rb
@@ -793,13 +951,13 @@

Files: 40

-Classes: 26 ( 12 undocumented)
-Modules: 16 ( 8 undocumented)
-Constants: 146 ( 92 undocumented)
+Classes: 26 ( 17 undocumented)
+Modules: 16 ( 12 undocumented)
+Constants: 146 (133 undocumented)
Attributes: 15 ( 11 undocumented)
-Methods: 235 (132 undocumented)
+Methods: 235 (138 undocumented)

-Total: 438 (255 undocumented)
- 41.78% documented
+Total: 438 (311 undocumented)
+ 29.00% documented

-Elapsed: 3.6s
+Elapsed: 3.8s

AND

The following items are not documented:

in files:

lib/fiddle.rb

lib/fiddle/function.rb

lib/fiddle/closure.rb

fiddle.c

module Fiddle

# in file lib/fiddle.rb
Pointer = nil
# in file fiddle.c
TYPE_VOID = nil
# in file fiddle.c
TYPE_VOIDP = nil
# in file fiddle.c
TYPE_CHAR = nil
# in file fiddle.c
TYPE_SHORT = nil
# in file fiddle.c
TYPE_INT = nil
# in file fiddle.c
TYPE_LONG = nil
# in file fiddle.c
TYPE_LONG_LONG = nil
# in file fiddle.c
TYPE_FLOAT = nil
# in file fiddle.c
TYPE_DOUBLE = nil
# in file fiddle.c
WINDOWS = nil
# in file lib/fiddle.rb
def last_error(); end

# in file lib/fiddle.rb
def last_error=(error); end

# in file lib/fiddle.rb
def win32_last_error(); end

# in file lib/fiddle.rb
def win32_last_error=(error); end

end

in files:

lib/fiddle/closure.rb

class Fiddle::Closure

attr_reader :ctype # in file lib/fiddle/closure.rb
attr_reader :args # in file lib/fiddle/closure.rb
end

in files:

lib/fiddle/closure.rb

class Fiddle::Closure::BlockCaller

# in file lib/fiddle/closure.rb
def new(ctype, args, abi = Fiddle::Function::DEFAULT, &block); end

# in file lib/fiddle/closure.rb
def call(*args); end

end

in files:

lib/fiddle/function.rb

fiddle.c

class Fiddle::Function

# in file function.c
DEFAULT = nil
# in file function.c
STDCALL = nil
attr_reader :abi # in file lib/fiddle/function.rb
# in file function.c
def new(p1, p2, p3, p4 = v4); end

# in file function.c
def call(*args); end

end

ruby_doc_updates-20110812-fiddle_vbatts.patch Magnifier - Fiddle (9.24 KB) Vincent Batts, 08/15/2011 01:37 PM

ruby_doc_updates-20110812-dl_vbatts.patch Magnifier - DL (15.1 KB) Vincent Batts, 08/15/2011 01:37 PM

Associated revisions

Revision 32981
Added by Eric Hodel almost 3 years ago

  • ext/.document (fiddle): Remove duplicate entry
  • ext/fiddle: Complete documentation of Fiddle. Patch by Vincent Batts. [#5192]

Revision 32982
Added by Eric Hodel almost 3 years ago

  • ext/dl: Add documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #5192]

History

#1 Updated by Eric Hodel almost 3 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r32982.
Vincent, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • ext/dl: Add documentation. Patch by Vincent Batts. [Ruby 1.9 - Bug #5192]

Also available in: Atom PDF