Class: FFI::Clang::TParamCommandComment

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

#depth ⇒ Object 



229
230
231
 
# File 'lib/ffi/clang/comment.rb', line 229

def depth
	Lib.tparam_command_comment_get_depth(@comment)
end

#index(depth = 0) ⇒ Object 



233
234
235
 
# File 'lib/ffi/clang/comment.rb', line 233

def index(depth = 0)
	Lib.tparam_command_comment_get_index(@comment, depth)
end

#name ⇒ Object 



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

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

#text ⇒ Object Also known as: comment 



216
217
218
 
# File 'lib/ffi/clang/comment.rb', line 216

def text
	self.child.text
end

#valid_position? ⇒ Boolean

Returns:

  • (Boolean) 


225
226
227
 
# File 'lib/ffi/clang/comment.rb', line 225

def valid_position?
	Lib.tparam_command_comment_is_param_position_valid(@comment) != 0
end