Documentation

Icon and Unicon

Icon

There are no formal conventions for documentation built into the Icon/Unicon. However, there are conventions for the different libraries that are supported by automation. <lang Icon>############################################################################

2. File: filename.icn
4. Subject: Short Description
6. Author: Author's name
8. Date: Date
11. This file is in the public domain. (or other license)
14. Long form docmentation
17. Links:

procedure x1() #: short description of procedure </lang>

Unicon

<lang Unicon>XYZ</lang>

This example is in need of improvement: Needs corresponding Unilib formats

Library: Icon Programming Library

[ipldoc.icn Program to collect library documentation. [iplindex.icn] Program to produce indexed listing of the program library.

Library: Unicon Code Library

TBD

J

Use scripdoc: <lang j>NB. ========================================================= NB.*apply v apply verb x to y apply=: 128!:2

NB. ========================================================= NB.*def c : (explicit definition) def=: :

NB.*define a : 0 (explicit definition script form) define=: : 0

NB.*do v name for ". do=: ".

NB.*drop v name for }. drop=: }.</lang>