 |
This web site contains source code documentation for:
Komodia LTD.
See the About page for usage notices.
|
|
Welcome!
This web site contains detailed source code documentation, hierarchy
charts, and navigational aids to help you quickly find the answers you
need to get your job done—without wading through large numbers of
header and source files in an editor.
Who Should Use this Web Site
This web site is designed for use by software professionals that are
responsible for developing, using, supporting, or documenting this code
base.
- Development Engineers:
Use this site to monitor the state of an evolving code base. Periodic
updates and reviews of this web help catch bugs early, help team members
maintain code consistency, and encourage code reuse by making it easy to
share information.
- Maintenance Engineers:
Use this site to find your way through a large code base to find the
answers you are looking for. The Edit from the Web feature (discussed
below) can quickly load related header and source files into your
program editor if you need to fix a problem.
- Quality Assurance Engineers:
Use this site as a guide when developing test cases.
- Documentation Specialists:
If you are developing end-user documentation, this site provides a
useful reference for the actual code base. This is often the best place
to look to determine how a software feature really works.
- Project Managers:
Use this site to keep track of recent coding activities. View objects
by modification time to quickly locate the most recent code changes. Use
the modification history pages to see specific change comments.
[Back to Top]
Navigating this Web Site
This object web site provides a great deal of information and uses a
variety of navigational mechanisms to help you quickly move around the
site. Below is a summary of these mechanisms along with tips for
getting the most out of this web site.
- Object Indices.
Use the "Arrange objects by" control to organize objects by different
criteria, depending on what your looking for--by name, by type, by last
modification time, or directory name, header file, and others.
- Object Overviews.
Every object has an overview page that provides the high-level view of
the object including: its description, sorted lists of all its
members, include file dependencies, message maps (if applicable), and
more.
- Drill Down.
Within an object's overview page, each member name is hyperlinked to a
member detail page. Each member page provides complete details about
the member--declaration, description text, implementation source code,
message map entries, default initialization, sample code, and so on--all
in one place.
- Hierarchy Charts.
From an object's overview page, or from any of its member pages, click
to view the
hierarchy chart for the object. Hierarchy charts help you understand an
object's inheritance structure. Before modifying an object, the
hierarchy chart can help you locate derived objects that may be
affected.
- Object Families.
Use the Top-level Chart
Index to understand the distinct object families documented in this
web site.
- Member Indices.
Once you drill into any object, you can click its
link (found at
the top of any of the object's pages) to display an index of the
object's members in place of the object index. The member index lets
you quickly navigate to different member pages without returning to the
main overview page for the object.
When you are finished using a member index,
click
or use the "View objects by" control to re-display the object
index.
- Autolinks.
The Autolink feature automatically creates hyperlinks that let you
quickly navigate to objects used in aggregations, associations,
parameter lists, template arguments, local variables, even referenced in
comments! Whenever you see the name of an object anywhere in a web page,
hover over the name. If that object is documented in the web, the name
will become highlighted, indicating that you can link directly to the
overview page for that object.
- Edit from the WebTM.
Use the Edit from the Web toolbar to quickly load into your favorite
editor the actual source for any documented item.
 Edit
Source |
When you locate an item you wish to edit, or if you would just like to
browse the actual header and/or source files, use the Edit Source
toolbar button. This button will take you directly from the web page to
the appropriate file and line number in your preferred editing
environment.
|
 Edit Genitor Object |
If the item is an object that was created with Genitor OCS, you can also
use toolbar buttons to: open the object in the Genitor OCS Class Editor,
generate a Quick Doc help file for the object, and access the object
repository for real-time status information.
|
Note: Edit from the Web requires ActiveX
support. See Recommended Browsers for
details.
- Finding Objects and Members.
Use the "Find in index" control to search for a name (or any string)
in the currently loaded object or member index. Click the Go button (or
hit enter) to locate the first matching item. Click Go (or hit enter)
again to locate additional matching items.
- Browse Sequences.
The various pages for each object (e.g., object overview, modification
history, hierarchy chart, member functions, sample code, and so on) are
arranged in browse sequences that simplify browsing through unfamiliar
code. Use the
buttons to browse back and forth through the pages for the
current object.
- Chromacoding.
Whenever actual source code is shown in the web (e.g., item
declarations, function bodies, custom code fragments, such as
preprocessor macro definitions, etc.), the code is colorized as it would
be in a professional editing environment. Colorized code is much easier
to understand.
- Supplemental Information.
Where available, browse supplemental information such as modification
histories, sample code, message maps, preprocessor macros and other
implementation details to broaden your understanding of the underlying
code.
- Site Details.
The
About this Web
Site page is the "About Box" for this web site. This page shows
when the web was last updated and provides details on the options used
to generate the site.
- Coming Home.
Click
to return to this
home page.
[Back to Top]
Object Types
This web site was generated
using Surveyor V4.50.811.1. Click
here
for more information. |
Site content copyright © 2003
Komodia LTD..
See the
About
page for additional notices.
This page last updated: 24 Feb 2003. |
This web site is best
viewed using Microsoft Internet Explorer 4.0 or higher. |
See
Edit from the Web ("Recommended Browsers") for information on browser
compatibility. |