YDOCMDLF (Document Model Files) Command

Documents the files within a design model.
ca2e87
Documents the files within a design model.
Contents
Optional
YDOCMDLF-Optional (128) YDOCMDLF-Optional (129) YDOCMDLF-Optional (130) YDOCMDLF-Optional (131)
Parameters
The following are parameters for the YDOCMDLF command.
MDLFILE
Specifies name of files you want to include in the listing. Values for these parameters are as follows:
  • *USER
    -- (default) List all user-defined files in the model.
  • *ALL
    -- List all files in the model, including system files.
APPCDE
Name of an application area to which the files that are listed belong. Values for these parameters are as follows:
  • *ALL
    -- (default) List files from all application areas.
PRTTEXT
Specifies whether narrative text for the file 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.
PRTREL
Specifies whether the relations that reference the file are included in the generated documentation. Values for these parameters are as follows:
  • *NO
    -- (default) Do not include relations.
  • *YES
    -- Include relations.
  • *FULL
    -- Print relations and associated field entries together with details of the field entry.
PRTACCPTH
Specifies whether the names of the access paths referenced by each file are included in the generated documentation. Values for these parameters are as follows:
  • *NO
    -- (default) Do not include access paths.
  • *YES
    -- Include access paths.
PRTFUN
Specifies whether the names of the functions that reference the file are included in the generated documentation. Values for these parameters are as follows:
  • *NO
    -- (default) Do not include functions.
  • *YES
    -- Include functions.
Notes
A library containing the model files must be present in the library list of the job that executes the YDOCMDLF command.
Example
To print all details about the model files in a model library:
YDOCMDLF PRTTEXT(*FUNC) PRTREL(*YES) + PRTACCPTH(*YES) PRTMSG(*YES)