Class: FFI::Clang::ParamCommandComment

Inherits:
Comment
  • Object
show all
Defined in:
lib/ffi/clang/comment.rb

Instance Method Summary collapse

Methods inherited from Comment

build_from, #child, #children, #each, #has_trailing_newline?, #initialize, #kind, #num_children, #whitespace?

Constructor Details

This class inherits a constructor from FFI::Clang::Comment

Instance Method Details

#direction ⇒ Object 



222
223
224
 
# File 'lib/ffi/clang/comment.rb', line 222

def direction
	Lib.param_command_comment_get_direction(@comment)
end

#direction_explicit? ⇒ Boolean

Returns:

  • (Boolean) 


218
219
220
 
# File 'lib/ffi/clang/comment.rb', line 218

def direction_explicit?
	Lib.param_command_comment_is_direction_explicit(@comment) != 0
end

#index ⇒ Object 



214
215
216
 
# File 'lib/ffi/clang/comment.rb', line 214

def index
	Lib.param_command_comment_get_param_index(@comment)
end

#name ⇒ Object 



200
201
202
 
# File 'lib/ffi/clang/comment.rb', line 200

def name
	Lib.extract_string Lib.param_command_comment_get_param_name(@comment)
end

#text ⇒ Object Also known as: comment 



204
205
206
 
# File 'lib/ffi/clang/comment.rb', line 204

def text
	self.map(&:text).join("")
end

#valid_index? ⇒ Boolean

Returns:

  • (Boolean) 


210
211
212
 
# File 'lib/ffi/clang/comment.rb', line 210

def valid_index?
	Lib.param_command_comment_is_param_index_valid(@comment) != 0
end