aboutsummaryrefslogtreecommitdiff
path: root/sucl/new.icl
diff options
context:
space:
mode:
authorzweije2001-07-03 09:08:47 +0000
committerzweije2001-07-03 09:08:47 +0000
commite0723cdd1c7ae60cb2e15affb50678623cab6365 (patch)
tree681b96ebc6d04339adeaf56b9441ee9cb8591955 /sucl/new.icl
parentcleaning up: removing all these hopelessly silly long function names (diff)
This commit was generated by cvs2svn to compensate for changes in r514,
which included commits to RCS files with non-trunk default branches. git-svn-id: https://svn.cs.ru.nl/repos/clean-compiler/trunk@515 1f8540f1-abd5-4d5b-9d24-4c5ce8603e2d
Diffstat (limited to 'sucl/new.icl')
-rw-r--r--sucl/new.icl46
1 files changed, 46 insertions, 0 deletions
diff --git a/sucl/new.icl b/sucl/new.icl
new file mode 100644
index 0000000..0531019
--- /dev/null
+++ b/sucl/new.icl
@@ -0,0 +1,46 @@
+new.lit - One line module description
+=====================================
+
+Description
+-----------
+
+Describe in a few paragraphs what this module defines.
+
+------------------------------------------------------------------------
+
+Interface
+---------
+
+Exported identifiers:
+
+> %export
+> identifier || One line description
+> ...
+
+Required types:
+
+ identifier - type@source.lit type@source.lit
+ ...
+
+------------------------------------------------------------------------
+
+Includes
+--------
+
+> %include "source.lit" || identifier ...
+> ...
+
+------------------------------------------------------------------------
+
+Implementation
+--------------
+
+Implementation of identifier
+
+> identifier
+> :: type
+
+> identifierone arguments
+> = body
+
+...