summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick White <nwhite@palantir.com>2014-09-03 17:58:20 +0100
committerNick White <nwhite@palantir.com>2014-09-03 17:58:20 +0100
commit2201752117cefdb804bb8309e48f98973c798d8d (patch)
tree7ab2ba1fbbf4046b1dbb35aa81dedb4eb012b2de
parent53fedc22339d1447b4690c352acce0d3010bfe21 (diff)
downloadffi-2201752117cefdb804bb8309e48f98973c798d8d.tar.gz
fix yard doc warnings
-rw-r--r--lib/ffi/autopointer.rb4
-rw-r--r--lib/ffi/library.rb20
-rw-r--r--lib/ffi/struct_layout_builder.rb4
-rw-r--r--lib/ffi/types.rb2
4 files changed, 17 insertions, 13 deletions
diff --git a/lib/ffi/autopointer.rb b/lib/ffi/autopointer.rb
index 5706068..f4ca7a1 100644
--- a/lib/ffi/autopointer.rb
+++ b/lib/ffi/autopointer.rb
@@ -183,8 +183,8 @@ module FFI
#
# Override {DataConverter#from_native}.
# @overload self.from_native(ptr, ctx)
- # @param [Pointer] ptr
- # @param ctx not used. Please set +nil+.
+ # @param [Pointer] ptr
+ # @param ctx not used. Please set +nil+.
# @return [AutoPointer]
def self.from_native(val, ctx)
self.new(val)
diff --git a/lib/ffi/library.rb b/lib/ffi/library.rb
index 47a0fa8..59836b8 100644
--- a/lib/ffi/library.rb
+++ b/lib/ffi/library.rb
@@ -292,6 +292,9 @@ module FFI
end
# @overload attach_variable(mname, cname, type)
+ # @param [#to_s] mname name of ruby method to attach as
+ # @param [#to_s] cname name of C variable to attach
+ # @param [DataConverter, Struct, Symbol, Type] type C variable's type
# @example
# module Bar
# extend FFI::Library
@@ -300,6 +303,8 @@ module FFI
# end
# # now callable via Bar.c_myvar
# @overload attach_variable(cname, type)
+ # @param [#to_s] mname name of ruby method to attach as
+ # @param [DataConverter, Struct, Symbol, Type] type C variable's type
# @example
# module Bar
# extend FFI::Library
@@ -307,9 +312,6 @@ module FFI
# attach_variable :myvar, :long
# end
# # now callable via Bar.myvar
- # @param [#to_s] mname name of ruby method to attach as
- # @param [#to_s] cname name of C variable to attach
- # @param [DataConverter, Struct, Symbol, Type] type C varaible's type
# @return [DynamicLibrary::Symbol]
# @raise {FFI::NotFoundError} if +cname+ cannot be found in libraries
#
@@ -360,10 +362,12 @@ module FFI
# @overload callback(name, params, ret)
+ # @param name callback name to add to type map
+ # @param [Array] params array of parameters' types
+ # @param [DataConverter, Struct, Symbol, Type] ret callback return type
# @overload callback(params, ret)
- # @param name callback name to add to type map
- # @param [Array] params array of parameters' types
- # @param [DataConverter, Struct, Symbol, Type] ret callback return type
+ # @param [Array] params array of parameters' types
+ # @param [DataConverter, Struct, Symbol, Type] ret callback return type
# @return [FFI::CallbackInfo]
def callback(*args)
raise ArgumentError, "wrong number of arguments" if args.length < 2 || args.length > 3
@@ -389,8 +393,8 @@ module FFI
end
# @param [DataConverter, Symbol, Type] old
- # @param add
- # @param [] info
+ # @param add
+ # @param info
# @return [FFI::Enum, FFI::Type]
# Register or get an already registered type definition.
#
diff --git a/lib/ffi/struct_layout_builder.rb b/lib/ffi/struct_layout_builder.rb
index 5ebb2ae..5e9e740 100644
--- a/lib/ffi/struct_layout_builder.rb
+++ b/lib/ffi/struct_layout_builder.rb
@@ -51,8 +51,8 @@ module FFI
@size = size if size > @size
end
- # @param [Numeric] alignment
- # Set alignment attribute with +alignment+ only if it is greater than attribute value.
+ # @param [Numeric] align
+ # Set alignment attribute with +align+ only if it is greater than attribute value.
def alignment=(align)
@alignment = align if align > @alignment
@min_alignment = align
diff --git a/lib/ffi/types.rb b/lib/ffi/types.rb
index 2085a9c..4e48a2c 100644
--- a/lib/ffi/types.rb
+++ b/lib/ffi/types.rb
@@ -155,7 +155,7 @@ module FFI
native_type Type::POINTER
# @param [Pointer] val
- # @param [] ctx
+ # @param ctx
# @return [Array(String, Pointer)]
# Returns a [ String, Pointer ] tuple so the C memory for the string can be freed
def self.from_native(val, ctx)