EuDoc - Euphoria documentation program


(c) D. Newhall


1. Introduction


EuDoc is a program for automatically creating documentation for Euphoria libraries. The file created has the same visual appearance as the library routines list in the official Euphoria documentation. It can also be used to document programs but in a more limited scope.

For EuDoc to work you first need to document your program using these tags. The tags are case insensitive and need not be in any order except that "Name:" and "Routine:" must come before a block of info relating to that but it's highly recommended that you use the capitalization scheme and order shown for better clarity. Also, to show emphasis or to do special formatting you just need to put the desired HTML tags in your comments.

  File descriptor tags:
    Name:            Name of library/program. Required first
    Author:          Author's name
    Created:         Date file was created
    Updated:         Date file was updated
    License:         License library's source code is released under
    Intro:           Introduction comments about the library

  Routine descriptor tags:
    Routine:         Name of the routine. Required first
    Author:          Author of the routine
    Created:         Date routine was created
    Updated:         Date routine was updated and contributor who did so
    Platform:        Platform the routine runs on
                         (General, WIN32, DOS32, Linux, FreeBSD)
    Syntax:          An illustration of the usage syntax
    Description:     A description of what the routine does
    Comments:        Extra comments about the routine
    Example:         A more example to illustrate usage
    Example Program: The name/location of an example program if such
                          a program exists
    See Also:        Lists other related routines in the library

  
To try out EuDoc type "ex EuDoc.ex EuDocLib.e" (remember to substitute "ex" for the name of the interpreter on your platform:"exu" for Linux and FreeBSD and "exw" for Windows). EuDocLib.e is the file that contains all the routines for use in EuDoc.ex. It's commented so as to produce the documentation you are reading right now! Besides the information on running EuDoc this file also contains documentation for the routines used by EuDoc as defined in EuDocLib.e as an example.

Please send all your comments, questions, suggestions, and bug reports to Derek Newhall.


2. Routines
   comment
   error
   generate_html
   get_command_line_options
   print_data
   read_line
   see_also_links
   trim
   trim_comment

 

... continue 3. Alphabetical Listing of All Routines, From A to Z