Modules | Files | Inheritance Tree | Inheritance Graph | Name Index | Config
module Synopsis::Formatter::HTML::FileIndexer
class FileIndexer
Files: Synopsis/Formatter/HTML/FileIndexer.py
FileIndexer-inheritance

A page that creates an index of files, and an index for each file. First the index of files is created, intended for the top-left frame. Second a page is created for each file, listing the major declarations for that file, eg: classes, global functions, namespaces, etc.


Operations Summary:
 __init__(self, manager) [Source]
 filename(self)
since FileTree generates a whole file hierarchy, this method returns the current filename, which may change over the lifetime of this object [Source]
 title(self)
since FileTree generates a while file hierarchy, this method returns the current title, which may change over the lifetime of this object [Source]
 register_filenames(self, start)
Registers a page for each file indexed [Source]
 process(self, start)
Creates a page for each file using process_scope [Source]
 process_scope(self, filename, file)
Creates a page for the given file. [Source]

Operation Details:
  process_scope(self, filename, file)

Creates a page for the given file. The page is just an index, containing a list of declarations.