Doc-O-Matic
 
Doc-O-Matic 6
PreviousUpNext
QA View

QA view gives you an impression about how well your source code is documented, which areas have documentation, and which have not. You can use the Filter to reduce the number of symbols in QA view.

  1. Right-click in the QA matrix.
  2. Do one of the following:
    • To show a matrix of dots, select Display Flat.
    • To show topics as hierarchy, select Display as Hierarchy.
  1. Right-click in the QA matrix.
  2. Select Show Info.

The following table describes toolbar buttons, commands, and keyboard shortcuts:

Button/ Popup/Check box 
Command 
Short cut 
Description 
 
Open Source 
ENTER 
Opens the source of the selected symbol using the registered application or the application set in the Application Options
 
Copy Topic ID to Clipboard 
 
Copies the topic ID of the current topic to the clipboard. All topic IDs of the project are listed in the Topic Picker of the Topic Editor
 
Go to Content Manager 
 
Switches to the Content Manager and high-lights the selected topic in the topic hierarchy. 
 
F4 
Creates a new topic for the current symbol according to the QuickDoc settings for the symbol type. 
 
Create Documentation 
CTRL+F4 
Creates a new topic for the current symbol if it has no documentation. 
 
New Topic 
 
Creates a new topic
 
QuickDoc Settings 
 
Changes QuickDoc Settings. 
 
Display as Hierarchy 
 
Displays symbols and topics hierarchically as tree map showing information about symbol structure such as namespaces and which symbols they contain. 
 
Display Flat 
 
Displays symbols and topics as matrix of dots. 
 
Select Colors 
 
Opens the QA View Options Application Options page where you can change all used colors. 
 
Save as Bitmap 
 
Saves the QA matrix as bitmap. 
 
Show Info 
 
Shows or hides hints for each item. 
 
Toggle Filter 
 
Shows or hides the Filter
Color/Partition 
Meaning 
Red 
Undocumented symbols 
Green 
Documented symbols and topics 
Yellow 
Symbols with inherited descriptions 
Blue 
Symbols that use the description of other topics by features such as combine and the overloaded function feature 
Grey 
Unfinished symbols and topics 
Green border for modules 
Symbols are grouped in modules 
Red/Green border for namespace 
Symbols in documented or undocumented namespaces 
Brown border for folder 
Symbols in folders 
Red/Green border for class 
Class members in documented or undocumented classes 

On the Quality Assurance Options page you can change the parameters for your quality checks. Using the error code for QA checks of the Command Line Compiler and the chk command you can check the documentation status of your project without building it.

Applies to: Doc-O-Matic Professional

Copyright (c) 2000-2008 toolsfactory software inc. All rights reserved.