Module: Reader (TmDoc)
Prev Chapter 3.  User Defined Modules and Classes  Next

Module: Reader (TmDoc)

Overview
Module Structure
Class Hierarchy
Module Methods
Reader.read / 4
Reader.read_source / 3
Reader.check_file / 3
Reader.valid_file_path? / 4
is a submodule of
module: TmDoc   
is modularized into
module: Ruby18   
class: FileItem   
class: SetOfFileItem   
has modular siblings
module: Commander   
module: Exception   
module: Environment   
module: Transformer   
module: Model   
module: Writer   
has properties
module method: read / 4   
module method: read_source / 3   
module method: check_file / 3   
module method: valid_file_path? / 4   
is defined at
#120 in constant.rb  
#13 in reader/reader.rb  

Overview

Module Structure
Class Hierarchy

Module Structure

  module: <Toplevel Module>
  module: TmDoc
  module: Commander
  module: Exception
  module: Environment
  module: Transformer
  module: Model
✗ module: Reader
  module: Ruby18     
  class: FileItem     
  class: SetOfFileItem     
  module: Writer

Class Hierarchy

  Object ( Builtin-Module )
  Abstract ( TmStd::Lsm )
  Abstract ( TmStd::Lsm::Product )
    FileItem ( TmDoc::Reader )   
  Abstract ( TmStd::Lsm::Collection )
  Abstract ( TmStd::Lsm::Collection::Set )
    SetOfFileItem ( TmDoc::Reader )   

Module Methods

Reader.read / 4
Reader.read_source / 3
Reader.check_file / 3
Reader.valid_file_path? / 4

Reader.read / 4

#64 in reader/reader.rb

read ( dir_name ,
  file_names ,
  env ,
  &logger )

Reader.read_source / 3

#125 in reader/reader.rb

read_source ( expand_file_path ,
  input_file_name ,
  env )

Reader.check_file / 3

#154 in reader/reader.rb

check_file ( dir_name ,
  file_name ,
  env )

Reader.valid_file_path? / 4

#178 in reader/reader.rb

valid_file_path? ( file_path ,
  file_name ,
  env ,
  does_log = true )

Prev Up Next
Module: Document (TmDoc::Model::DocBook)  Home  Module: Ruby18 (TmDoc::Reader)