Module Hierarchy

• yagdoc
  • common: Miscellaneous utilities, possibly will be merged into other modules.
  • docblock: Process source code docstrings.
  • docbook: Writing DocBook XML.
  • inspector: Constructing GObject C inspector and parsing its output.
  • linker: DocBook XML cross-reference resolution conversion.
  • makefile: Makefile variable extraction.
  • parser: Parsing token soup to a declaration tree according to C grammar.
  • scanner: Scanning individual declarations in the parse tree.
  • sectionizer: Sorting declarations into sections.
  • tokenizer: Separation of C code into tokens.
  • tool: Yagdoc command line tool helper.
  • version: Version information

Class Hierarchy

• __builtin__.object: The most base type
  • exceptions.BaseException: Common base class for all exceptions
    • exceptions.Exception: Common base class for all non-exit exceptions.
      • yagdoc.common.DataError: A recoverable error in input data.
        • yagdoc.docblock.DocBlockError: Base class for docblock exceptions
          • yagdoc.docblock.DuplicateFieldError: Duplicate field
          • yagdoc.docblock.DuplicateSymbolError: Duplicate documentation block
          • yagdoc.docblock.DuplicateTraitError: Duplicate trait
          • yagdoc.docblock.EndInCommentError: File ended in a documentation block
          • yagdoc.docblock.EndInQuoteError: Documentation block ended inside a quoted block
          • yagdoc.docblock.InvalidOverrideError: Invalid override
          • yagdoc.docblock.MalformedLineError: Malformed documentation block line
          • yagdoc.docblock.MismatchedQuoteError: Closing quote does not match opening
          • yagdoc.docblock.MisplacedOverrideError: Override is not allowed here
          • yagdoc.docblock.MissingNameError: Documentation block lacks symbol/section name
          • yagdoc.docblock.StrayClosingQuoteError: Stray closing quote
        • yagdoc.docbook.DocBookException: Base class for DocBook writer exceptions
          • yagdoc.docbook.TooFewSignalArguments: Signal documentation has less arguments than the signal
          • yagdoc.docbook.TooManySignalArguments: Signal documentation has more arguments than the signal
        • yagdoc.linker.LinkerError: Base class for linker errors
          • yagdoc.linker.DuplicityError: Id is not unique
          • yagdoc.linker.GtkDocIndexError: Unparsed gtk-doc index record
          • yagdoc.linker.IndexFileTypeError: Unknown index file type
          • yagdoc.linker.PackageNameError: Bad package name
          • yagdoc.linker.ValidityError: Not a valid yagdoc index
        • yagdoc.parser.ParserError: Cannot parse block
        • yagdoc.scanner.ScannerError: Base class for scanner exceptions
          • yagdoc.scanner.AnonymousError: Declaration has no top-level name
          • yagdoc.scanner.EnumValueClashError: Multiple definitions of an enum value
          • yagdoc.scanner.NameClashError: Multiple definition of symbol
          • yagdoc.scanner.TypeStructMergeError: Failed to merge struct and typedef
        • yagdoc.tokenizer.TokenizerError: Base class for tokenizer errors
          • yagdoc.tokenizer.BadConditionalNestingError: Preprocessor conditional has never started
          • yagdoc.tokenizer.InvalidMacroError: Invalid macro definition
          • yagdoc.tokenizer.JunkError: Unrecognized token
          • yagdoc.tokenizer.UnexpectedEndError: Base class for unexpected input termination errors
            • yagdoc.tokenizer.EndInCommentError: Input ended inside a multi-line comment
            • yagdoc.tokenizer.EndInConditionalError: Input ended inside a preprocessor conditional
            • yagdoc.tokenizer.EndInContinuationError: Input ended immediately after a line continuation
            • yagdoc.tokenizer.EndInStringError: Input ended inside a backslash-continued multiline string
      • yagdoc.inspector.InspectorError: Base class for inspector exceptions
        • yagdoc.inspector.InvalidFlagsError: Flag list has not the form <allowed-flags-characters>
        • yagdoc.inspector.InvalidHookNameError: Hook name is invalid
        • yagdoc.inspector.InvalidStringError: Malformed quoted string
        • yagdoc.inspector.JunkError: Malformed line
        • yagdoc.inspector.UnknownSectionError: Section is not known
      • yagdoc.makefile.MakefileException: Base class for Makefile exceptions
        • yagdoc.makefile.RecursionException: Infinite variable reference recursion
      • yagdoc.sectionizer.SectionizerException: Base class for sectionizer exceptions
        • yagdoc.sectionizer.InvalidRule: Malformed sectioning rule
  • yagdoc.inspector.Binding: Representation of the inspected information about one keyboard binding.
  • yagdoc.scanner.Declaration: One documentable declaration.
  • yagdoc.docblock.DocBlock: Documentation of one symbol.
  • yagdoc.docblock.DocScanner: Documentation comment block scanner.
  • yagdoc.common.FileTimes
  • yagdoc.linker.IndexItem: An index item.
  • yagdoc.inspector.InspectConstructor: Customize and write inspect program C code.
  • yagdoc.inspector.Inspector: Parse inspect GObject inspection output.
  • yagdoc.linker.Linker: Map from symbol names to URIs.
  • yagdoc.linker.LinkMap: Abstract base class for link maps.
    • yagdoc.linker.GtkdocLinkMap: Gtk-doc link map.
    • yagdoc.linker.YagdocLinkMap: Yagdoc link map.
  • yagdoc.tokenizer.Macro: Macro definition.
  • yagdoc.makefile.Makefile: Makefile parser and variable extractor.
  • yagdoc.parser.Parser: Token soup parser.
  • yagdoc.inspector.Property: Representation of the inspected information about one GObject property.
  • yagdoc.sectionizer.Rule: Signle sectionizer rule.
  • yagdoc.scanner.Scanner: Declaration scanner.
  • yagdoc.docbook.Section: One reference documentation section.
  • yagdoc.sectionizer.Sectionizer: Set of rules for sorting symbols into sections.
  • yagdoc.inspector.Signal: Representation of the inspected information about one GSignal.
  • yagdoc.tokenizer.Token: Single source code text token.
  • yagdoc.tokenizer.Tokenizer: Tokenizer and preprocessor.
  • yagdoc.scanner.Tree: Expanded parse tree branch.
  • __builtin__.type: type(object) -> the object's type type(name, bases, dict) -> a new type
  • yagdoc.inspector.Type: Representation of the inspected information about one GType.