› FFI::Clang › Source › FFI › Clang › InlineCommandComment

class InlineCommandComment

Represents an inline command comment (e.g., \c, \p).

Definitions

def name

Get the command name.

Signature
returns　String

The inline command name (e.g., "c", "p").

Implementation

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

def render_kind

Get the render kind for this inline command.

Signature
returns　Symbol

The render kind.

Implementation

 
def render_kind
	Lib.inline_command_comment_get_render_kind(@comment)
end

def num_args

Get the number of arguments to this command.

Signature
returns　Integer

The number of arguments.

Implementation

 
def num_args
	Lib.inline_command_comment_get_num_args(@comment)
end

def args

Get all arguments to this command.

Signature
returns　Array<String>

An array of argument strings.

Implementation

 
def args
	num_args.times.map {|i|
		Lib.extract_string Lib.inline_command_comment_get_arg_text(@comment, i)
	}
end

def text

Get the text by joining all arguments.

Signature
returns　String

The joined argument text.

Implementation

 
def text
	args.join
end