CodeMiner
Version 0.99
Released On December 7, 1999 @ 00:59:35
Copyright © 1999 By Amazon Beach Software . All Rights Reserved.

[ Overview | Features | Limitations | Useage Scenarios | System Requirements | Installation | Archive Files ]

OVERVIEW FEATURES LIMITATIONS USEAGE SCENARIOS SYSTEM REQUIREMENTS PROGRAM INSTALLATION PROGRAM USAGE OVERVIEW ARCHIVE FILES
[OUTPUT] Required Section
Description=TEXT(Project Archive) Place a short description here
Output=PATH(C:\CODEMINE\DOCS) The path where the auto-documentation HTML files should be written
[PACKAGES] Required Section
Package=FILENAME(C:\CODEMINE\TOOLS.PF) Enter the 1st Package (.PF) file name here including path
Package=FILENAME(C:\CODEMINE\APP.PF) Enter the 2nd Package (.PF) file name here including path
Repeat these entries as many times as needed to load all desired package files at once.
[IDENTITY] Required Section
CompanyName=TEXT(Company Name) Place your companies name here
GroupName=TEXT(Group Name) Place your group's name here
Webside=URL(Web Address Here) Place your companies web address here using the full URL such as http://www.aaaaa.com
[CROSS LINKING] Required Section
LibsToLibs=YES {YES | NO} This flag specifies whether definitions from libraries are cross-linked to other libraries.
LibsToApps=YES {YES | NO} This flag specifies whether applications are cross-linked back to library definitions
AppsToLibs=NO {YES | NO} This flag specifies whether libraries are cross-linked back to applications (rarely used).
AppsToApps=NO {YES | NO} This flag specifies whether applications are cross-linked to other applications (only enable when definitions from one application are use in another).
[DOCUMENT COLORS] Required Section (Use color values 0...255)
Text=RGB(0,0,0) The color of all text other than the special colors defined below
Background=RGB(204,204,228) The background color for each HTML page
HyperLink=RGB(0,0,128) The color of all hyperlinks which have not been visited yet.
VisitedLink=RGB(0,0,128) The color of all visited hyperlinks.
Heading=RGB(0,32,160) The text color for extract comment headings
Description=RGB(160,32,0) The text color for extracted comment section bodies.
TableHeading=RGB(128,128,128) The background heading color for all tables that are filled.
TableData=RGB(224,224,224) The background data color for all tables thare are filled.
[VALIDATION TOKENS] Required Section
Token=ASSERT Specifies a unique token to associate with runtime/debug error testing
Token=assert Specifies a unique token to associate with runtime/debug error testing
Repeat this entry as many times as needed for all macros and functions that should be associated with error testing.
[ALLOCATION TOKENS] Required Section
Token=new Specifies a unique token which represents dynamic memory allocation
Token=alloc Specifies a unique token which represents dynamic memory allocation
Repeat this entry as many times as needed for all macros and functions that should be associated with memory allocation.
[DEALLOCATION TOKENS] Required Section
Token=delete Specifies a unique token which represents dynamic memory release
Token=free Specifies a unique token which represents dynamic memory release
Repeat this entry as many times as needed for all macros and functions that should be associated with memory release.
[THREAD START TOKENS] Required Section
Token=_beginthread Specifies a unique token which represents a thread entry point
Token=StartThread Specifies a unique token which represents a thread entry point
Repeat this entry as many times as needed for all macros and functions that should be associated with thread initiation.
[THREAD STOP TOKENS] Required Section
Token=_endthread Specifies a unique token which represents a thread exit point
Token=StopThread Specifies a unique token which represents a thread exit point
Repeat this entry as many times as needed for all macros and functions that should be associated with thread termination.
[THREAD YIELD TOKENS] Required Section
Token=Sleep Specifies a unique token which represents a yield of system resources.
Repeat this entry as many times as needed for all macros and functions that should be associated with thread/process yielding.
[SEMAPHORE SIGNAL TOKENS] Required Section
Token=SIGNAL Specifies a unique token which represents signaling of a semaphore.
Repeat this entry as many times as needed for all macros and functions that should be associated with semaphore signaling.
[SEMAPHORE BLOCKING TOKENS] Required Section
Token=WAIT Specifies a unique token which represents a thread waiting for a semaphore to be signaled.
Repeat this entry as many times as needed for all macros and functions that should be associated with semaphore waiting/blocking.
[MUTEX LOCKING TOKENS] Required Section
Token=LockCriticalSection Specifies a unique token which represents a critical section entry point.
Repeat this entry as many times as needed for all macros and functions that should be associated with mutex (critical section) entry points.
[MUTEX UNLOCKING TOKENS] Required Section
Token=UnlockCriticalSection Specifies a unique token which represents a critical section exit point.
Repeat this entry as many times as needed for all macros and functions that should be associated with mutex (critical section) exit points.
[SIMPLE COMMENT HEADINGS] Required Section - entries in this section designate source code comment sections as being simple. Simple means the comment is rendered without indentation etc.
AUTHOR=shared/author.gif This entry designates all source code comment sections "AUTHOR: ..." as simple entities and uses the designated GIF file for a tag leader.
AUTHOR(s)=shared/author.gif This entry designates all source code comment sections "AUTHOR(s): ..." as simple the same as the entry above.
(Please see the included archive file for a more entry ideas).
[COMPLEX COMMENT HEADINGS] Required Section - entries in this section designate source code comment sections as being complex. Complex means the comment is rendered with the section title on a separate line and bullets are supported etc.
PURPOSE=shared/purpose.gif This entry designates all source code comment sections "PURPOSE: ..." as complex entities and uses the designated GIF file for a tag leader.
DESCRIPTION=shared/description.gif This entry designates all source code comment sections "DESCRIPTION: ..." as complex entities and uses the designated GIF file for a tag leader.
(Please see the included archive file for a more entry ideas).



PACKAGE FILE FORMAT
[SETTINGS] Required Section
NAME=WIDGETS Enter a very short code name here which represents the name of the package such as MATH, UTILS, EQUIP, DATABASE etc.
TYPE=LIBRARY {LIBRARY} - Where the pool of source code represents a static or dynamic library developed within your company or the source code has been provided from another company.
{APPLICATION} - Where the pool of source code represents a executable target which can be run by a user.
{FIRMWARE} - Where the pool of source code represents a embedded executable.
{VENDOR} - When a set of definitions (and source if available) is being scanned to complete all low-level definitions.
DESCRIPTION=INFO(Short Description Goes Here) Enter a very short description of this package, for example "Math Utilities" etc.
ROOT=PATH(C:\UTILS) This is a cosmetic entry and path correctness does not matter. This entry displayed on the main Package pages so that users will have general idea of where the package definitions exist.
DEFINTIONS=PATH(C:\UTILS) This entry specifies the location of the definitions (Header Files) for the package target. This path must be correct and valid. Please note long file names are not yet available so keep this in mind when editing this entry.
IMPLEMENTATIONS=PATH(C:\UTILS) This entry specifies the location of the implementations (Source Files) for the package target. This path must be correct and valid. Please note long file names are not yet available so keep this in mind when editing this entry.
[MODULES] Required Section
GROUP=MASKS(*.h,*.cpp) This entry specifies the file masks to use for detecting the definition (Header Files) and implementation (Source Files). The file search is conducted in the corresponding directories specified above.


[ Overview | Features | Limitations | Useage Scenarios | System Requirements | Installation | Archive Files ]

(Revised January 23, 2006 by Webmaster )