VBdocman is a program for automatic generating of technical documentation from your Visual Basic source files with just few mouse clicks. It parses source code and automatically creates table of contents, index, topics, cross-references and context sensitive help. The format of output documentation is fully configurable by user. The predefined output formats are:
HTML Help (*.chm file which looks like MSDN)-
HTML files (with Java index and table of contents)
WinHelp (*.hlp file)
VBdocman works as an add-in into MS Visual Basic 6.0. After invoking simple dialog through main menu and (in the simplest case) clicking one button the specified output documentation is generated. It automatically creates all interesting links such as Applies To, Methods, Events, Properties, Events, table of contents and index. In greater projects only this work saves many days of boring work. Documentation can be then edited and additional description given there such as See Also, Examples links, object, method, property or event description, parameters description and so on. VBdocman allows to add even that description automatically by extracting it from source code comment from special tags. It works similarly as JavaDoc system. But, user is not forced to write comments manually, VBdocman adds it itself just by two mouse clicks. All necessary tags are added and user then fills just short description to them. In addition, it provides sophisticated user-friendly comment editor.
Consistency. If something was added to code e.g. new method, it is automatically reflected in newly generated documentation.
Documentation in various formats can be generated by few mouse clicks. So you have documentation in all supported formats in few minutes.
Efficient communication within the team, especially when Source Safe is used. Every programmer comments his part of code.
» version 2.25 - posted on 2005-11-09
Enhanced output and bug fixes.
EULA - End User License Agreement
VBDOCMAN LICENSE AGREEMENT
The VBdocman Add-In is NOT freeware. This means:
All copyrights to VBdocman are exclusively owned by the author - Peter Macej (HELIXOFT).
Anyone may use this software during a trial period of 14 days.
Following this trial period of 14 days or less, if you wish to continue
to use VBdocman, you MUST register (buy). When you buy VBdocman, you become
There are following types of licenses issued for VBdocman:
1. A single computer USAGE license. The user purchases ONE license
to USE the VBdocman on ONE computer.
2. A SITE USAGE license. The user purchases a single USAGE license,
authorising the USE of VBdocman, by the purchaser, the purchasers
employees or accredited agents, on an unlimited number of computers
at the same physical SITE location. This SITE location would
normally be defined as a single building, but could be considered
to be a number of buildings within the same, general, geographical
location, such as an industrial estate or small town.
Once registered, the user is granted a non-exclusive license to use
VBdocman on as many computers as defined by the licensing terms above
according to the number of licenses purchased, for any legal purpose.
You may not use, copy, emulate, clone, rent, lease, sell, modify,
decompile, disassemble, otherwise reverse engineer, or transfer the
licensed program, or any subset of the licensed program, except as
provided for in this agreement. Any such unauthorized use shall
result in immediate and automatic termination of this license and may
result in criminal and/or civil prosecution.
The VBdocman trial version, may be freely distributed,
provided the distribution package is not modified. No person or
company may charge a fee for the distribution of VBdocman without written
permission from the author.
To register see VBdocman home site http://www.vbdocman.com
Author does not warrant that the functions contained in this software
will meet your requirements or that the software will be error free.
IN NO EVENT WILL AUTHOR BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY
LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OR INABILITY TO USE THIS PROGRAM, OR FOR ANY CLAIM
BY ANY OTHER PARTY. THE ENTIRE RISK AS TO THE RESULTS AND PERFORMANCE OF
THE PROGRAM AND DOCUMENTATION IS ASSUMED BY YOU.
Author retains title to the ownership of the software. All copies and
portions of the software, in any form, belong to author who retains
all rights not expressly granted.
Installing and using VBdocman signifies acceptance of these terms and
conditions of the license.
If you do not agree with the terms of this license you must remove VBdocman
files from your storage devices and cease to use the product.