You are here: Interface Components > View Tab
Other Interface Components
Doc-O-Matic Tools
Messages
> QA View
Close
Doc-O-Matic 10
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 the 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 shortcuts:

Group
Icon
Command
Shortcut
Description
Display
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
Display Flat
Displays symbols and topics as matrix of dots.
Display
Show Info
Shows or hides hints for each item.
Display
Filter
Shows or hides the Filter.
Display
Save as Bitmap
Saves the QA matrix as bitmap.
Display
Open Source
ENTER
Opens the source of the selected symbol using the registered application or the application set in the Application Options.
Document
F4
Creates a new topic for the current symbol according to the QuickDoc settings for the symbol type.
Document
>
QuickDoc Settings
Changes QuickDoc Settings.
Document
Document
CTRL+F4
Creates a new topic for the current symbol if it has no documentation.
Document
New Topic
Creates a new topic.
Document
New Snippet
Creates a new snippet.
Document
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.
Document
Go to Content Manager
Switches to the Content Manager and high-lights the selected topic in the topic hierarchy.
Document
Select Colors
Opens the QA View Options Application Options page where you can change all used colors.
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 © 2000-2020 toolsfactory software inc. All rights reserved.