Sybernet / Supplied Procedures Reference
Release 3.00
Jan 13, 2004

HTTP.SP_DOCUMENT

This procedure documents a stored procedure, function, and package. If only it were that simple. What it does is create a standard heading and footing. It also displays your procedure's synopsis including parameters and return values. All you have to do is fill in the missing bits. This document, for example, was created by sp_document.

The template that is created was inspired from the way Oracle documents their packages. Besides being consistent among all packages, their documentation is very easy to read. That is what I tried to accomplish here. Pacakges in particular are worth noting. A package name submitted to SP_DOCUMENT will also create a Summary of Subprograms, and you can drill-down on the subprogram name to get its detail description. Although the summary does not duplicate overloaded functions, overloaded functions are documented in the detail (as you would expect).

To be complete a "See Also" section is created. This includes links to any objects that call your object or any objects that your object calls. Most of the time you will want to delete these links.

Syntax

Procedure SP_DOCUMENT
(
    OBJECT_NAME                   VARCHAR2
,   BGCOLOR                       VARCHAR2
,   LINK                          VARCHAR2
,   VLINK                         VARCHAR2
,   ALINK                         VARCHAR2
)   ;

Parameters

Parameter	Description
object_name	The object name to document.
bgcolor	Background color of document.
link	Determines the color of a non-visited link.
vlink	Determines the color of a visited link.
alink	Determinse the color of an active link.

Example

The following example illustrates how to call sp_document:

sp_document('http.sp_document');