method

add_constant

Ruby latest stable (v2_5_5) - 0 notes - Class: RDoc::Context

1_8_6_287 (0)
1_8_7_72 (0)
1_8_7_330 (0)
1_9_1_378 (0)
1_9_2_180 (5)
1_9_3_125 (38)
1_9_3_392 (0)
2_1_10 (0)
2_2_9 (0)
2_4_6 (0)
2_5_5 (0)
2_6_3 (0)
What's this?

add_constant(constant) public

Adds constant if not already there. If it is, updates the comment, value and/or is_alias_for of the known constant if they were empty/nil.

Show source

# File lib/rdoc/context.rb, line 426
  def add_constant constant
    return constant unless @document_self

    # HACK: avoid duplicate 'PI' & 'E' in math.c (1.8.7 source code)
    # (this is a #ifdef: should be handled by the C parser)
    known = @constants_hash[constant.name]

    if known then
      known.comment = constant.comment if known.comment.empty?

      known.value = constant.value if
        known.value.nil? or known.value.strip.empty?

      known.is_alias_for ||= constant.is_alias_for
    else
      @constants_hash[constant.name] = constant
      add_to @constants, constant
    end

    constant
  end

add_constant

Related methods