REBOL [
    Title: "Simple prebol-based autodoc system"
    Purpose: {
        Automatic generation of program documentation from program
        source.
    }
    Author: "Gabriele Santilli"
    EMail: giesse@rebol.it
    File: %autodoc.r
    License: {
Copyright (c) 2003, Gabriele Santilli
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

* Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer. 
  
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the following
  disclaimer in the documentation and/or other materials provided
  with the distribution. 

* The name of Gabriele Santilli may not be used to endorse or
  promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
    }
    Date: 26-Feb-2004
    Version: 1.3.0 ; majorv.minorv.status
                   ; status: 0: unfinished; 1: testing; 2: stable
    History: [
        26-Feb-2004 1.1.0 "History start"
        26-Feb-2004 1.2.0 "First version, SET-DOC-FILE and DOCUMENT implemented"
        26-Feb-2004 1.3.0 "Added example usage"
    ]
]

context [
    current-document-file: none
    
    set-doc-file:
        func [
            "Set the file to output documentation to"
            file [file!]
        ] [
            ; using CLEAN-PATH so that file name is valid even while #including
            ; a script from another directory
            current-document-file: clean-path file
        ]

    document:
        func [
            "Append documentation to the output file"
            text [string!]
        ] [
            ; this function should always return none or unset
            write/append current-document-file text
        ]

    system/words/set-doc-file: :set-doc-file
    system/words/document: :document
]

; example usage:
;   at the begginning of your main script,
;     #do [do %autodoc.r set-doc-file %doc.txt none]
;   to document your scripts,
;     #do [document {
;        ....
;     }]