Sample Source - Simple Class

The following block of source code shows how to include a table of codes / descriptions as part of the documentation for a function. This is useful for documenting fixed codes with descriptions associated with parameters or returned values for a function.

This block of sample code also shows how overloaded functions can be documented with duplicating information in the source file.

function ReqClient   (dest$, value$)                        Request_Client

function ReqClient   (dest$, value$, path$)                 Request_Client

! ** Send information to Eclipse workbench
! ** @param dest$ Delivery destination for information - value must be "C"
! ** @param value$ Message to write to the console view
! ** @param path$ (Optional) Path to resource referenced by action
! ** @param overwrite (Optional) Overwrite existing value in Bookmark or Problem View (0 = False, 1 = True)
! ** @value heading=Destination Codes
! ** @value B Create a bookmark for resource in the bookmark view
! ** @value C Write a message to the console view
! ** @value P write an entry for resource to the Problem view
! ** @value S write an entry for resource to 'Classic Search' view
function ReqClient   (dest$, value$, path$, overwrite)      Request_Client

Function Declaration With Table of Codes

Generated HTML Documentation