Class: Doxyparser::Friend

Inherits:
Member show all
Defined in:
lib/nodes/friend.rb

Overview

A friend member declared inside a C++ Class. Can itself refer to an external Function or Class

Instance Attribute Summary

Attributes inherited from Member

#args, #definition, #location, #params, #static, #type

Attributes inherited from Node

#basename, #dir, #doc, #name, #node, #parent

Instance Method Summary collapse

Methods inherited from Member

#file

Methods inherited from Node

#==, #eql?, #escaped_name, #initialize, #to_s, #to_str

Methods included from Util

#del_prefix_class, #del_prefix_file, #del_spaces, #do_filter, #escape_all, #escape_class_name, #escape_const_ref_ptr, escape_const_ref_ptr, #escape_file_name, #escape_template, home_dir, #match, read_file, write_file

Constructor Details

This class inherits a constructor from Doxyparser::Node

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Doxyparser::Node

Instance Method Details

#is_class? ⇒ Boolean

Returns true if the friend declaration refers to a Class false if refers to a Doxyparser::Function.

Returns:



7
8
9
 
# File 'lib/nodes/friend.rb', line 7

def is_class?
  args.nil? || args == ""
end

#is_qualified? ⇒ Boolean

Returns true if the name used in the declaration is fully qualified (using the ‘::’ operator) false otherwise.

Returns:

  • (Boolean) —

    true if the name used in the declaration is fully qualified (using the ‘::’ operator) false otherwise



12
13
14
 
# File 'lib/nodes/friend.rb', line 12

def is_qualified?
  basename.include? '::'
end