diff options
author | Will Andrews <will@FreeBSD.org> | 2001-04-07 07:57:20 +0000 |
---|---|---|
committer | Will Andrews <will@FreeBSD.org> | 2001-04-07 07:57:20 +0000 |
commit | d3c69b69280c35856309f9d4dedf27b5c318e506 (patch) | |
tree | 85dfb15ecd9fb3befc1dde36210ddd9237d0f93c /devel/ocamlweb/pkg-descr | |
parent | 56108469586d2be2faea76cfb047b2c4716ea541 (diff) |
Notes
Diffstat (limited to 'devel/ocamlweb/pkg-descr')
-rw-r--r-- | devel/ocamlweb/pkg-descr | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/devel/ocamlweb/pkg-descr b/devel/ocamlweb/pkg-descr new file mode 100644 index 000000000000..caa9c6cac9de --- /dev/null +++ b/devel/ocamlweb/pkg-descr @@ -0,0 +1,22 @@ +Literate programming has been introduced by D. E. Knuth in 1984. The +main idea is to put the code and its documentation in the same file +and to produce from it a document which is readable by a human, and +not only by a machine. Although ocamlweb borrows a lot of ideas from +Knuth's original tool (called WEB), there are big differences between +them. First, WEB allows you to present the pieces of your code in any +order, and this is quite useful when using poorly structured +languages, like Pascal or C. But Objective Caml is already highly +structured, and this is no more useful. Moreover, WEB requires the use +of a tool to produce the code from the WEB file, which greatly +complicates the use of your favorite source-based tools (dependencies +generator, debugger, emacs mode, etc.). When using ocamlweb, the +documentation is inserted in the code as comments (in the Caml sense), +and your code is not linked to the existence of ocamlweb in any way. + +Currently, the task of ocamlweb may be seen as: + + 1. making a nice document with the code and its documentation; + 2. generating a global index of cross-references, where each identifier + is associated to the lists of sections where it is defined or used. + +WWW: http://www.lri.fr/~filliatr/ocamlweb |