Class: LanguageParser::JavaClass

Inherits:
LanguageClass show all
Defined in:
lib/cgialib/lp/JavaLanguageScanner.rb

Overview

class : JavaClass

A specialization for LanguageClass to handle the JavaDoc markup on a Java class declaration

Instance Attribute Summary collapse

Attributes inherited from LanguageClass

#comments, #methods, #name, #parents, #type, #variables

Instance Method Summary collapse

Methods inherited from LanguageClass

#add_method, #add_parent, #add_variable, #to_s

Constructor Details

#initialize ⇒ JavaClass

initialize()

Constructor



63
64
65
66
67
68
69
70
 
# File 'lib/cgialib/lp/JavaLanguageScanner.rb', line 63

def initialize()
  
  super()
  
  @javadoc = nil
  @javadocClass = JavaDoc
  
end

Instance Attribute Details

#javadoc ⇒ Object (readonly)

The JavaDoc attached to the class



72
73
74
 
# File 'lib/cgialib/lp/JavaLanguageScanner.rb', line 72

def javadoc
  @javadoc
end

#javadocClass ⇒ Object

The class to use to build the JavaDoc object



74
75
76
 
# File 'lib/cgialib/lp/JavaLanguageScanner.rb', line 74

def javadocClass
  @javadocClass
end

Instance Method Details

#comments=(text) ⇒ Object

comments=( text )

text - The comment text

Overrides the comment text setter to build the JavaDoc as well as setting the comment



83
84
85
86
87
88
89
90
 
# File 'lib/cgialib/lp/JavaLanguageScanner.rb', line 83

def comments=( text )
  
super( text )
  
  @javadoc = @javadocClass.new() unless ( @javadoc )
  @javadoc.parse( text )
  
end