API Reference

This document lists APIs of the swift_rst_docs module to generate documentation pages programmatically.

Contents

• Example
• Generation
  • fetch_documents()
  • generate_documentation()
  • GenerationContext
    • GenerationContext.body
    • GenerationContext.documented_objects
    • GenerationContext.documented_symbols
    • GenerationContext.find()
    • GenerationContext.fullnames
    • GenerationContext.index_title
    • GenerationContext.min_accessibility
    • GenerationContext.overview
  • main()
• Parsing
  • parse()
  • fetch_fullnames()
  • replace_links()
  • highlight_statement()
  • prettify_swift_declaration()
• Types
  • Accessibility
    • Accessibility.FILEPRIVATE
    • Accessibility.INTERNAL
    • Accessibility.OPEN
    • Accessibility.PRIVATE
    • Accessibility.PUBLIC
    • Accessibility.UNKNOWN
    • Accessibility.order
  • AnnotatedDeclaration
    • AnnotatedDeclaration.chunks
    • AnnotatedDeclaration.parsed
  • Annotation
    • Annotation.chunk
    • Annotation.usr
  • DeclarationKind
    • DeclarationKind.CLASS
    • DeclarationKind.CLASS_METHOD
    • DeclarationKind.CLASS_VARIABLE
    • DeclarationKind.ENUM
    • DeclarationKind.ENUM_ELEMENT
    • DeclarationKind.EXTENSION
    • DeclarationKind.FUNCTION
    • DeclarationKind.INSTANCE_METHOD
    • DeclarationKind.INSTANCE_VARIABLE
    • DeclarationKind.LOCAL_VARIABLE
    • DeclarationKind.PROTOCOL
    • DeclarationKind.STATIC_METHOD
    • DeclarationKind.STATIC_VARIABLE
    • DeclarationKind.STRUCT
    • DeclarationKind.UNKNOWN
  • Documentation
    • Documentation.comment
    • Documentation.discussion
    • Documentation.name
    • Documentation.parameters
    • Documentation.result
    • Documentation.usr
  • MARK
    • MARK.name
  • MainPage
  • ModulePage
    • ModulePage.declaration
    • ModulePage.members
    • ModulePage.name
    • ModulePage.title
  • Page
    • Page.contents
    • Page.file_name
  • Structure
    • Structure.name
  • Symbol
    • Symbol.accessibility
    • Symbol.context
    • Symbol.declaration
    • Symbol.documentation
    • Symbol.inherited_types
    • Symbol.kind
    • Symbol.module_name
    • Symbol.name
    • Symbol.substructure
    • Symbol.usr