Lecture overview -- Keyboard shortcut: 'u'  Previous page: Scheme Elucidator Details -- Keyboard shortcut: 'p'  Next page: Multi-semicolon style -- Keyboard shortcut: 'n'  slide -- Keyboard shortcut: 't'  Help page about these notes  Alphabetic index  Course home  Page 5 : 8
Scheme Program Documentation Tools
SchemeDoc

Lexical concepts - easy

Tool modes - first and foremost source extraction

SchemeDoc is a tool for extraction, authoring, and presentation of Scheme library documentation

  • Comment block: A sequence of consequtive Scheme comment lines

  • Documentation comment: A specially marked comment block

    • Levels: abstract, section, and definition comments

    • Styles: Multi-semicolon and documentation-mark

  • Documentation markup language

    • A little language for internal structuring of docmentation comments

SchemeDoc can be used in four operational modes: Manual mode, source extraction mode, and two different XML modes