Package yagdoc :: Module linker :: Class YagdocLinkMap
[show private | hide private]
[frames | no frames]

Type YagdocLinkMap

object --+    
         |    
   LinkMap --+
             |
            YagdocLinkMap


Yagdoc link map.
Method Summary
  comment_handler(self, data)
XML parser comment handler for yagdoc indices.
  default_handler(self, data)
Default XML handler for yagdoc indices.
  end_element_handler(self, name)
XML parser element end handler for yagdoc indices.
  scan(self, source)
Read entries from a yagdoc index.
  start_element_handler(self, name, attrs)
XML parser element start handler for yagdoc indices.
  xml_decl_handler(self, version, encoding, standalone)
XML parser XML declaration handler for yagdoc indices.
Inherited from LinkMap: __init__, add_item, check_name
Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Instance Variable Summary
Inherited from LinkMap: errors

Method Details

comment_handler(self, data)

XML parser comment handler for yagdoc indices.

Comments are ignored.

default_handler(self, data)

Default XML handler for yagdoc indices.

Everything not handler by the other handlers is an error.

end_element_handler(self, name)

XML parser element end handler for yagdoc indices.

scan(self, source)

Read entries from a yagdoc index.

This method should not be called explicitly, only by LinkMap initialization.
Parameters:
source - Index, its name attribute will be used as the source name (if set). It can be a file or any other iterable returning strings that can be fed to the XML parser.
           (type=iterable of str)

start_element_handler(self, name, attrs)

XML parser element start handler for yagdoc indices.

xml_decl_handler(self, version, encoding, standalone)

XML parser XML declaration handler for yagdoc indices.

The XML declaration is ignored.

Generated by Epydoc 2.1 on Fri Oct 5 00:36:53 2007 http://epydoc.sf.net