CA 2E Toolkit Commands, YD to YW › YDOCOBJLST (Document Object List) › Parameters › Notes

Notes

1. This command takes a long time to execute: even if only a single program is specified the command must analyze the entire library to obtain information about where the program is called.
2. The report produced by the YDOCPGM command contains the following sections for each program, command, or menu: Object header details and compiler options:

   Compiler options as specified by Z*or /*Z: comment lines in source. Synopsis/Function narrative:

   As specified by H*or /*H:comment lines in source.

   • File usage:

     – Files and data areas called by the program.

     – Compile-time file overrides as specified by Y*or /*Y:comment lines in source.

   • Linkage details:

     – Entry parameters

     – Objects and menus called by the program

     – Objects and menus that call the program. Maintenance notes:

   As specified by M*or /*M:comment lines in source. Warning notes:

   As specified by W*or /*W:comment lines in source.

3. When run as part of an interactive job, the YDOCPGM command may not be used to document libraries that are in the system part of the job’s library list. If you wish to document such libraries interactively, first use the i OS command Change System Value (CHGSYSVAL) to remove the libraries from the system part of the job’s library list.
4. When run as part of a batch job, the YDOCPGM command always removes all libraries except QSYS from the system part of the job’s library list. Thus the command may be used to document libraries that are in the system part of the library list. Note however, that if you use the YDOCPGM command in your own programs, you may want to restore the system part of the library list after invoking the command.