Home       Trees       Index       Help   

Yagdoc

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

Module yagdoc.linker

DocBook XML cross-reference resolution conversion.
Classes
GtkdocLinkMap Gtk-doc link map.
IndexItem An index item.
Linker Map from symbol names to URIs.
LinkMap Abstract base class for link maps.
YagdocLinkMap Yagdoc link map.

Exceptions
DuplicityError Id is not unique
GtkDocIndexError Unparsed gtk-doc index record
IndexFileTypeError Unknown index file type
LinkerError Base class for linker errors
PackageNameError Bad package name
ValidityError Not a valid yagdoc index

Function Summary
str demangle_gtkdoc_id(name)
Attempt to figure out the symbol name from mangled gtk-doc id.
  demangle_id(name)
bool is_mixed_case(name)
Check whether a name is mixed-case.

Function Details

demangle_gtkdoc_id(name)

Attempt to figure out the symbol name from mangled gtk-doc id.

This is a bloody heuristics.
Parameters:
name - Mangled name as it appears in gtk-doc id attributes.
           (type=str)
Returns:
Original symbol name (with a bit of luck).
           (type=str)

is_mixed_case(name)

Check whether a name is mixed-case.

This is a bloody heuristics.
Parameters:
name - Name to test.
           (type=str)
Returns:
True if name seems to be mixed-case.
           (type=bool)

   Home       Trees       Index       Help   

Yagdoc

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