› FFI::Clang › Source › FFI › Clang › TParamCommandComment

class TParamCommandComment

Represents a template parameter documentation command (e.g., \tparam).

Definitions

def text

Get the documentation text for this template parameter.

Signature
returns　String

The template parameter documentation text.

Implementation

 
def text
	self.child.text
end

def name

Get the template parameter name being documented.

Signature
returns　String

The template parameter name.

Implementation

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

def valid_position?

Check if the parameter position is valid.

Signature
returns　Boolean

True if the position is valid in the template parameter list.

Implementation

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

def depth

Get the nesting depth of this template parameter.

Signature
returns　Integer

The nesting depth.

Implementation

 
def depth
	Lib.tparam_command_comment_get_depth(@comment)
end

def index(depth = 0)

Get the index of this template parameter at the specified depth.

Signature
parameter　depth　Integer

The nesting depth (defaults to 0).

returns　Integer

The index at the specified depth.

Implementation

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