File UniAll.icn

Summary

This file defines a series of classes that can be used associate Unicon language entities with comments and components.

The intent is to provide a basis for generating documentation (e.g. HTML) from Unicon source files. The classes constructed by the the UniAll::processFile() method embody all the relevant information needed to generate documentation about a Unicon program and/or library file.

Author: Steve Wampler (sbw@tapestry.tucson.az.us)

This file is in the public domain.

Classes:
UniAll

Procedures:
mkCallStr, mkList, mkListStr, mkParamListStr

Global variables:
fixName

Imports:
lang, parser, util

This file is part of the UniDoc package.

Source code.

Details
Procedures:

mkCallStr(obj)

Given a UniDoc::UMethod(), UniDoc::UConstructor(), UniDoc::UProc(), UniDoc::UClass(), or UniDoc::URecord(), produces a string showing the syntax of call.


mkList(aSet)

Given a UniDoc::Set() or a UniDoc::Sequence(), produces a list of the entities contained in it, sorted by name.


mkListStr(sequence)

Given a UniDoc::Sequence(), produces a string showing that list.


mkParamListStr(sequence)

Given a UniDoc::Sequence() representing a field or parameter list, produces a string showing that parameter list (including the enclosing parentheses).


Global variables:
fixName


This page produced by UniDoc on 2021/04/15 @ 23:59:54.