› FFI::Clang › Source › FFI › Clang › ParamCommandComment

class ParamCommandComment

Represents a parameter documentation command (e.g., \param, \arg).

Definitions

def name

Get the parameter name being documented.

Signature
returns　String

The parameter name.

Implementation

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

def text

Get the documentation text for this parameter.

Signature
returns　String

The parameter documentation text.

Implementation

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

def valid_index?

Check if the parameter index is valid.

Signature
returns　Boolean

True if the parameter index is valid.

Implementation

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

def index

Get the parameter index in the function signature.

Signature
returns　Integer

The zero-based parameter index.

Implementation

 
def index
	Lib.param_command_comment_get_param_index(@comment)
end

def direction_explicit?

Check if the parameter direction is explicitly specified.

Signature
returns　Boolean

True if the direction is explicit (e.g., [in], [out]).

Implementation

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

def direction

Get the parameter direction.

Signature
returns　Symbol

The direction (:in, :out, or :in_out).

Implementation

 
def direction
	Lib.param_command_comment_get_direction(@comment)
end