Project
name: DelphiCodeToDoc Linker
Exe
name: dctdlnk2.exe
Version:
2.0.0
Licence:
open source
DCTD
version compatible: 0.8+
Author:
l0co
DOWNLOAD
EXEcutable - DCTDLinker2_exe.zip
Source - DCTDLinker2_source.zip
Documentation - DCTDLinker2_doc.pdf
DESCRIPTION
This
application simply creates links in documentation generated by
DelphiCodeToDoc 0.8. This is version is based on completely new
code with improved performance and more intelligent links detecting.
HOW IT WORKS
First
scans the source directory and reflects project structure in memory.
Then scans each file from the project, and when hits known item
name, creates a list of items which have the same name, and ranks
the items with following rules:
If
there's single word:
. each
item gets 20 points for each the same owner (in compare with item
associated with currently
scanned file); for example "item" in file "project_unit_class_item.htm"
has 3 owners:
"project", "unit" and "class"
. each
item gets 15 points, if belongs to the class, which is one of
currently scanned class ancestor
If
there's complex word (owners.item), searches the item with given
name and the same owners list
(each found item gets 12 points).
Finally
chooses the item with the biggest rank and creates link. If there's
more items with given maximum
rank, the link isn't created (see +L option).
USAGE
Application
works from command line, with following parameters:
DCTDLNK2
[options] <source_dir> [destination_dir]
Where:
. options
-
optional list of options (see below)
. source_dir
-
source directory with DCTD project files
. destination_dir
-
optional destination directory; if not specified rewrites current
project
Options
have to be preceded by plus (toggles the option on) or minus (toggles
the option off).
Current
version has following options:
. D
- writes log to debug.log file
. L
- creates uncertain links; if there's more item with the same
maximum rank, link is created to
first of them
. C
- copies all non-html files located in source directory to the
destination; works only if source
and destination directory are not the same; this option is on
by default
. S
- overwrites project CSS file with his own CSS
INTERNET
DCTD:
http://dephicodetodoc.sourceforge.net
DCTDLNK2:
http://l0co.webpark.pl
Bug
report: l0co@wp.pl
|