YDOCMDLFUN (Document Model Functions) Command

Documents the functions within a design model.
ca2e87
Documents the functions within a design model.
Contents
Optional
YDOCMDLFUN-Optional (135) YDOCMDLFUN-Optional (136) YDOCMDLFUN-Optional (137) YDOCMDLFUN-Optional (138) YDOCMDLFUN-Optional YDOCMDLFUN-Optional (140) YDOCMDLFUN-Optional (141) YDOCMDLFUN-Optional (142) YDOCMDLFUN-Optional YDOCMDLFUN-Optional YDOCMDLFUN-Optional YDOCMDLFUN-Optional
Parameters
The following are parameters for the YDOCMDLFUN command.
MDLFILE
Name of a file, or generic name of some files, to which the functions that are listed belong. Values for these parameters are as follows:
  • *USER
    -- (default) List functions that belong to all user-defined files in the model.
  • *ALL
    -- List functions that belong to all files in the model, including system files.
  • *SELECT
    -- Display the files in the current model, one of which may be selected.
MDLFUN
Name of a function that is listed, or generic name of functions that are listed. The value for this parameter is as follows:
  • *ALL
    -- (default) List all functions for the specified files.
APPCDE
Name of an application area to which the files referenced by the listed functions belong. The value for this parameter is as follows:
  • *ALL
    -- (default) List functions that reference files from all application areas.
FUNTYPE
Types of functions you want listed. Must be one of the standard function types or a special value. Values for these parameters are as follows:
  • *ALL
    -- (default) List all types of functions.
  • *INT
    -- List only internal functions.
  • *EXT
    -- List only external functions.
  • *DBF
    -- List only database functions.
  • *DEV
    -- List only device functions.
  • *DFN
    -- List only define screen/report format functions.
  • *FLD
    -- List only field functions.
  • *MSG
    -- List only message functions.
  • *USR
    -- List only user functions.
  • *SCR
    -- List only display device functions.
  • *RPT
    -- List only report device functions.
  • *DSP
    -- List only display functions.
  • *UPD
    -- List only edit functions.
  • Other values
    -- See the notes section for function types and classes.
PRTFUNOPT
Specifies whether the function options are included in the generated documentation. Values for these parameters are as follows:
  • *NO
    -- (default) Do not print function options.
  • *YES
    -- Print function options.
PRTTEXT
Specifies whether any narrative text for the function is included in the generated documentation, and if so, which type of text. Values for these parameters are as follows:
  • *NONE
    -- (default) Do not include narrative text.
  • *FUNC
    -- Include functional text.
  • *OPER
    -- Include operational text.
PRTPARM
Specifies whether the parameters of the listed functions are included in the listing. Values for these parameters are as follows:
  • *NONE
    -- (default) Do not print any function parameters.
  • *ENTRY
    -- Include the entry parameters of each function in the listing.
  • *ALL
    -- Include the *ENTRY parameters of each function in the listing. Include the parameters used to call other functions in each function's action diagram.
PRTDEVSTR
Specifies whether the device structures of the listed functions are included in the listing. Only report design functions (types PRTOBJ and PRTFIL) have device structures. Values for these parameters are as follows:
  • *NO
    -- (default) Do not print any function device structures.
  • *YES
    -- Include the function device structures in the listing.
PRTDEVDSN
Specifies whether the device (panel and report) designs of the listed functions are included in the listing. Values for these parameters are as follows:
  • *NO
    -- (default) Do not print any function device designs.
  • *YES
    -- Include the function device designs in the listing.
PRTDEVDTL
Specifies whether the device details (that is, field details listed by format) of the listed functions are included in the listing. Values for these parameters are as follows:
  • *NONE
    -- (default) Do not print any function device details.
  • *BASIC
    -- Print basic details of all fields on each format of the device design.
  • *FULL
    -- Print details of display attributes of fields present on the device design (that is, not hidden or dropped) as well as basic details of all fields on each format of the device design.
PRTFUNREL
Specifies whether the device design relations of the listed functions are included in the listing. Values for these parameters are as follows:
  • *NO
    -- (default) Do not print any function relations.
  • *YES
    -- Include the function relations in the listing.
PRTACTDIAG
Specifies whether the action diagrams of the listed functions are included in the listing, and if so, to what level of detail the diagrams are reported. Values for these parameters are as follows:
  • *NONE
    -- (default) Do not print any action diagrams.
  • *FULL
    -- Print complete action diagram.
  • *SUMMARY
    -- Print only the summary or top level of the action diagram.
  • *USER
    -- Print only the user modifiable points in each action diagram.
  • *USERMOD
    -- Print only the user modifications to action diagrams.
  • *FUN
    -- Print only the calls to other functions.
PRTABO
Specifies whether the action bar details of the listed functions are included in the listing. Ignored if PRTDEVDSN (*NO) is specified. Values for these parameters are as follows:
  • *NONE
    -- (default) Do not print any function action bar details.
  • *BASIC
    -- Print basic details of the action bars on the device design.
  • *FULL
    -- Print full details of the action bars on the device design.
FUNLVL
Indicates the number of invocation levels of the functions' action diagrams to print. Ignored if PRTACTDIAG(*NONE) is specified. Values for these parameters are as follows:
  • 1
    -- Print the action diagram of the first level function only.
  • 2-9
    -- Print the action diagrams of the functions called by the first level function, and those called by the second level function, up to the specified level.
PRTCHGDAT
Specifies the change dates printed for the action diagrams of the listed functions. Values for these parameters are as follows:
  • *NONE
    -- (default) Do not print any change dates.
  • *ALL
    -- Print all change dates.
  • Otherwise, PRTCHGDAT is a list parameter made up of two elements:
  • Date operator:
    • *EQ
      -- (default) Equal to
    • *LT
      -- Less than
    • *GT
      -- Greater than
  • Date (entered in system date format)
BGNNEWPAG
Specifies whether documentation for a function or file is to start on a new page or not. Values for these parameters are as follows:
  • *DFT
    -- (default) Start a new page on page overflow.
  • *FILE
    -- Start a new page for each file whose functions are to be documented.
  • *FUNCTION
    -- Start a new page for each function documented.
Notes
A library containing the model files must be present in the library list of the job that executes the YDOCMDLFUN command.
  • Specifying either *BASIC or *FULL for the PRTDEVDTL parameter provides a separate summary of any attached device user source functions.
The following table shows the function groups.
Function type
Abbreviation
Class
Sub-class
Implem. Type
Display/Update
Change object
*CHGOBJ
*DBF
-
*INT
-
Create object
*CRTOBJ
*DBF
-
*INT
-
Delete object
*DLTOBJ
*DBF
-
*INT
-
Retrieve object
*RTVOBJ
*DBF
-
*INT
-
Define screen format
*DFNSCRFMT
*DFN
*SCR
-
-
Define report format
*DFNRPTFMT
*DFN
*RPT
-
-
Prompt record
*PMTRCD
*DEV
*SCR
*EXT
*DSP
Display record 1
*DSPRCD
*DEV
*SCR
*EXT
*DSP
Display record 2
*DSPRCD2
*DEV
*SCR
*EXT
*DSP
Display record 3
*DSPRCD3
*DEV
*SCR
*EXT
*DSP
Edit record (1 screen)
*EDTRCD
*DEV
*SCR
*EXT
*UPD
Edit record (2 screens)
*EDTRCD2
*DEV
*SCR
*EXT
*UPD
Edit record (3 screens)
*EDTRCD3
*DEV
*SCR
*EXT
*UPD
Select record
*SELRCD
*DEV
*SCR
*EXT
*DSP
Display file
*DSPFIL
*DEV
*SCR
*EXT
*DSP
Edit file
*EDTFIL
*DEV
*SCR
*EXT
*UPD
Display transactions
*DSPTRN
*DEV
*SCR
*EXT
*DSP
Edit transactions
*EDTTRN
*DEV
*SCR
*EXT
*UPD
Print file
*PRTFIL
*DEV
*RPT
*EXT
-
Print object
*PRTOBJ
*DEV
*RPT
*INT
-
Execute internal funct.
*EXCINTFUN
*USR
-
*INT
-
Execute external funct.
*EXCEXTFUN
*USR
-
*EXT
-
Execute user program
*EXCUSRPGM
*USR
-
*EXT
-
Execute user source
*EXCUSRSRC
*USR
-
*INT
-
Send error message
*SNDERRMSG
*MSG
-
-
-
Send status message
*SNDSTSMSG
*MSG
-
-
-
Send information msg
*SNDINFMSG
*MSG
-
-
-
Send completion msg
*SNDCMPMSG
*MSG
-
-
-
Retrieve message
*RTVMSG
*MSG
-
-
-
Execute message
*EXCMSG
*MSG
-
*EXT
-
Derived field function
*FUNFLD
*FLD
-
*INT
-
 
Example
To print all details about the functions attached to all model files in a model library:
YDOCMDLFUN PRTTEXT(*FUNC) + PRTFUNPAR(*YES) PRTDEVDSN(*YES) + PRTACTDIAG(*YES)