File UniHTML.icn

Summary

Support for generating HTML documentation files from UniDoc.

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

This file is in the public domain.

Classes:
UniHTML

Procedures:
adjustDir, checkSpecial, cmts2html, decr, displayFrameRef, displaySrcURL, displayURL, fixName, getTag, getTagFromURL, isSubDir, listFrameRef, makeDirPath, makeTag, mkSrcURL, navFrameRef, openStdHtmlFile, outputCalls, outputComments, outputFunction, outputHeading, outputParComments, outputVar, outputVarComments, outputVars, pageBottom, pageTop, parseClause, parseFails, parseGenerates, parseParams, parseReturns, parseThrows, protectLine, stripParagraph, writeSrcFile

Global variables:
dirFlag, fileMap

Imports:
lang, util

This file is part of the UniDoc package.

Source code.

Details
Procedures:

adjustDir(fName)

This is intended for internal use only!

checkSpecial(s, keyMap)

Check for any special UniDoc comment fields. This is intended for internal use only!

cmts2html(comments)

This is intended for internal use only!

decr(n)

displayFrameRef(ref, label)

This is intended for internal use only!

displaySrcURL(obj, label)

Provide a reference into the source code, if possible. If not possible, just return the label.

displayURL(ref, label)

This is intended for internal use only!

fixName(pName)

This is intended for internal use only!

getTag(obj)

This is intended for internal use only!

getTagFromURL(url)

This is intended for internal use only!

isSubDir(fName)

Does the file name include a directory component? This is intended for internal use only!

listFrameRef(ref, label)

This is intended for internal use only!

makeDirPath(fName)

Ensure a directory path exists. This is intended for internal use only!

makeTag(s)

Convert a string into an HTML reference tag.

mkSrcURL(obj)

Construct a reference into the source code, if possible.

This is intended for internal use only!

navFrameRef(ref, label)

This is intended for internal use only!

openStdHtmlFile(path, name, mode)

This is intended for internal use only!

outputCalls(page, label, aList)

This is intended for internal use only!

outputComments(page, label, comments)

This is intended for internal use only!

outputFunction(page, metd)

This is intended for internal use only!

outputHeading(page, label, fSize, bColor)

Produce a nice looking heading (adapted from code by Robert Parlett)

This is intended for internal use only!

outputParComments(page, label, comments)

Output parameter comments

outputVar(page, var)

This is intended for internal use only!

outputVarComments(page, varName, comments)

This is intended for internal use only!

outputVars(page, label, aList)

This is intended for internal use only!

pageBottom(page, sFlag)

This puts out the common information at the bottom of each page. If sFlag is non-null, just terminates the page quietly.

This is intended for internal use only!

pageTop(page)

This puts out the common information at the top of each page.

This is intended for internal use only!

parseClause(s, kMap)

Parse a special UniDoc comment field. This is intended for internal use only!

So far have <[ram comment fields.

parseFails(s)

Parse a special UniDoc "fail" comment field. This is intended for internal use only!

parseGenerates(s)

Parse a special UniDoc "generate" comment field. This is intended for internal use only!

parseParams(s)

Parse a special UniDoc "param" comment field. This is intended for internal use only!

parseReturns(s)

Parse a special UniDoc "return" comment field. This is intended for internal use only!

parseThrows(s)

Parse a special UniDoc "throws" comment field. This is intended for internal use only!

protectLine(s)

Hide any characters in a string that might interfere with HTML processing by replacing them with their HTML equivalents.

stripParagraph(s)

This is intended for internal use only!

writeSrcFile(targetDir, uFile)

Output a source code file as an HTML document.

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