CONTENTS

  Title Page

  Copyright Page

  Preface

  1      Introduction
    1.1 DECset
    1.2 Source Code Analyzer (SCA)
    1.3 Language-Sensitive Editor (LSE)
    1.4 Designing Programs and Generating Reports

  2      Getting Started Designing Programs
    2.1 Entering Design Information with LSE
      2.1.1      Entering Design Information for a Module
      2.1.2      Adding Design Information for a Routine
      2.1.3      Entering Pseudocode
      2.1.4      Moving Pseudocode to Comments
      2.1.5      Using Overview Operations
      2.1.6      Completing the Implementation
    2.2 Retrieving Design Information
      2.2.1      Transferring Design Information to an SCA Library
      2.2.2      Using an SCA Keyword Query
      2.2.3      Generating Reports
      2.2.4      Using LSE Packages and Help Text

  3      Entering Design Information Using LSE
    3.1 Introduction
    3.2 Expressing Design Information Using Program Structure
    3.3 Expressing Design Information Using Comments
      3.3.1      Using Tagged Comments
      3.3.2      Associating Comments with Declarations
    3.4 Expressing Design Information Using Pseudocode
      3.4.1      Using Pseudocode in Data Declarations
      3.4.2      Using Pseudocode in Algorithms
      3.4.3      Refining the Design

  4      Retrieving Design Information
    4.1 Using Overviews to Retrieve Design Information
    4.2 Transferring Design Information to an SCA Library
      4.2.1      Compiling Design Information
      4.2.2      Loading Design Information into an SCA Library
    4.3 Using Keyword Queries
    4.4 Generating Reports
      4.4.1      Using the Report Commands
      4.4.2      General Report Information
      4.4.3      DOMAIN Option
      4.4.4      FILL Option
      4.4.5      DESIGN_EXAMPLE Source File
      4.4.6      Creating Online HELP
      4.4.7      Creating LSE Package Definitions
      4.4.8      Creating INTERNALS Reports
      4.4.9      Creating 2167A Software Design Reports
        4.4.9.1      Describing 2167A Structure in your Code
        4.4.9.2      Retrieving 2167A Structure Information
      4.4.10     Options for Standard Reports

  5      Customizing Reports
    5.1 Introduction
    5.2 How Reports are Organized
    5.3 Overview of Report Processing
    5.4 Modifying Report Source Files
    5.5 Changing the Default Value of an Option
    5.6 Modifying Query Expressions
    5.7 Adding New Tags and Keyword Lists
    5.8 Modifying Tag Names
    5.9 Modifying Section Headers and Other Fixed Text
    5.10 Deleting Information from a Report
    5.11 Customizing 2167A Reports
      5.11.1     Adding a Section to a 2167A Report
      5.11.2     Using Program Code For Report Information