class DataMetaDom::VerDoccable

Anything having a version. It must be also documentable, but not everything documentable is also versionable, like, for example, Record Field or an Enum part.

Attributes

ver[RW]

The version info, an instance of Ver.

Public Class Methods

verConsumed?(src) click to toggle source

Attempts to parse an instance of Ver from the current line on the given instance of SourceFile. Returns the instance of Ver if successful, nil otherwise. Parameter:

src - the instance of SourceFile to parse the version info from.

# File lib/dataMetaDom/ver.rb, line 239
def self.verConsumed?(src)
    src.line =~ /^\s*#{VER_KW}\s+(\S+)\s*$/ ? Ver.new($1) : nil
end

Public Instance Methods

resetEntity() click to toggle source

Resets stateful information on the entity level, like docs that should not apply to the next entity if missing.

# File lib/dataMetaDom/ver.rb, line 229
def resetEntity
    docs.clear
end