Summary

Generate HTML documentation from Unicon (or Icon) source files.

Syntax: unidoc arg...

where arg may be an option or a Unicon source file name or a directory name. Options apply from the point of occurrence until changed later in the argument list. When given a directory name, all Unicon source files in that directory are processed as if they appeared at that point in the argument list.

Options:

--resolve	-- Attempt to generate HTML from files listed in link and import statements.
--noresolve	-- Don't try to find files listed in link and import statements. (default)
--linkSrc	-- Include links from documentation back to source code.
--nolinkSrc	-- Don't include links from documentation back to source code. (default)
--indexFile=FILE	-- Name of base HTML file (default is index.html)
--targetDir=DIR	-- where to put generated HTML documents
--sourcePath=PATH	-- where to look for source files (besides ".") PATH is a space-separated list of directories
--linkPath=PATH	-- where to look for existing HTML files for entities that can't be found in source files. This is a comma-separated list of directories. Not yet implemented
--title=TITLE	-- Title for display on base HTML index page. (default is "Generated Documentation"

Methods, constructors, and procedures may include some special UniDoc tag fields:

• <[param parameter description of parameter]>
  
• <[generates description of generated results]>
  
• <[returns description of returned result]>
  
• <[fails description of failure causes]>
  
• <[throws exception description of cause of exception]>
  

As a special case, placing procedure and method parameters on separate lines with a comment describing each parameter on the same line, as in:

    # <p>
    # Invoke a class method by name.
    # <[returns the outcome of the invocation]>
    # <[fails if no method exists with that name]>
    # </p>
    method invoke(mName,    # Name of method to call
                  args[]    # Remaining arguments are arguments to call
                  )
        if hasMethod(mName) then {
            suspend (self.__m[mName]) ! push(args, self)
            }
    end

    # <p>
    # Invoke a class method by name.
    # <[param mName Name of method to call]>
    # <[param args[] Remaining arguments are arguments to call]>
    # <[returns the outcome of the invocation]>
    # <[fails if no method exists with that name]>
    # </p>
    method invoke(mName, args[])
        if hasMethod(mName) then {
            suspend (self.__m[mName]) ! push(args, self)
            }
    end

This version is preliminary and no doubt contains numerous bugs and omissions.

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

This file is in the public domain.

This file is part of the (main) package.

helpMesg()

main(args)

processArgs(uniAll)