Implementing Your Application › Documenting Your Generated Application

Documenting Your Generated Application

To generate technical documentation, the Document Model Functions (YDOCMDLFUN) command uses the operational text (or functional text if no operational text is available) from your model.

• Function text—Creates an introduction to the function.
• Device design text—Creates an introduction to the panel.
• Field text—Creates a description of each field on the panel.
• Condition text—Creates a description of each allowed value for a field.

Note: The Edit Object Text panel initially shows functional text.

Two types of text are allowed for each CA 2E object:

• Functional text that the designer enters to describe the object's purpose; this text may include restrictions and notes on design decisions.
• Operational text that the developer enters to describe functions, panels, fields, and conditions for end users.

CA 2E includes commands to produce hard copy documentation of your model, including dependencies between objects. You can invoke these commands from the Display Services Menu or call them directly.

You can add functional or operational text using the Edit Object Text panel. For access:

• Type N (narrative text) next to the item you want to document. The Edit Narrative Text (Functional) panel displays.
• Press F20 (operational text) to go to the Edit Narrative Text (Operational) panel.CA 2E incorporates the text you enter on this panel into the help text for the generated function.

For more information

• On documenting your model:
  • For fields, refer to the chapter titled "Documenting Your Data Model" in the Defining a Data Model Guide.
  • For access paths, refer to the chapter titled "Documenting Access Paths" in the Building Access Paths Guide.
  • For functions, refer to the chapter titled "Documenting Functions" in Building Applications.

On Toolkit documentation commands, refer to the CA 2E Toolkit Reference Guide under commands that begin with the letters YDOC.