› FFI::Clang › Source › FFI › Clang › BlockCommandComment

class BlockCommandComment

Represents a block command comment (e.g., \brief, \return).

Definitions

def name

Get the command name.

Signature
returns　String

The block command name (e.g., "brief", "return").

Implementation

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

def paragraph

Get the paragraph comment associated with this block command.

Signature
returns　Comment

The paragraph comment.

Implementation

 
def paragraph
	Comment.build_from Lib.block_command_comment_get_paragraph(@comment)
end

def text

Get the text content from the paragraph.

Signature
returns　String

The text content.

Implementation

 
def text
	self.paragraph.text
end

def num_args

Get the number of arguments to this command.

Signature
returns　Integer

The number of arguments.

Implementation

 
def num_args
	Lib.block_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.block_command_comment_get_arg_text(@comment, i)
	}
end