VBdocman .NET 1.0 - An Automatic Generator of Technical Documentation for VB .NET Projects


1. OVERVIEW

VBdocman .NET is a program for the quick automatic generation of technical documentation from your Visual Basic .NET source code files. VBdocman parses the Visual Basic .NET source code and automatically creates the table of contents, index, topics, cross-references, and context sensitive help. The format of output documentation is fully configurable by user. VBdocman can also serve as very sophisticated comment editor.
The predefined output formats are:

  - Help 2 (the latest Microsoft help technology used in Visual Studio .NET)
  - HTML Help (*.chm file which looks like MSDN)
  - HTML files (with Java index and table of contents)
  - RTF document
  - XML

User is allowed to define his own format for any ASCII based document such 
as LATEX, custom HTML and others.



2. HOW IT WORKS

VBdocman .NET works as an add-in with MS Visual Studio .NET. After invoking a simple dialog through main menu and (in the simplest case) clicking one button, the specified output documentation is generated. All interesting links such as Methods, Properties, Events, table of contents and index are created automatically. In large projects, VBdocman will save many days of boring tedious work. After VBdocman completes it's processing, the documentation can be edited, and additional descriptions can be added, e.g. See Also, Exceptions links, object, method, property or event description, parameters description, etc. VBdocman .NET can also extract that additional descriptions from the Visual Basic .NET source code comments when special tags are used.
It works similarly as JavaDoc system or C# XML documentation. But, user is not forced to write comments manually, VBdocman .NET adds it itself just by two mouse clicks. All necessary tags are added and then user fills in just short description to them. Solutions are also supported. In addition, VBdocman provides user-friendly comment editor. The types of information that can be extracted are as follows:

  - See Also links
  - Class, interface, structure, enumeration, namespace, method, property, event, delegate, variable or constant description
  - Parameters description
  - Settings description
  - Return value
  - Exceptions
  - Remarks
  - Example
  - Author
  - Version
  - Revision
  - Source code, declaration
  - User defined information



3. INSTALLATION

Before installing VBdocman uninstall any previous versions of VBdocman installed
on your computer. Then just unzip installation package and run installation MSI file. VBdocman will be
installed. After that it should be accessible in Visual Studio .NET IDE Add-Ins list. Detailed
help is also available. 



4. UNINSTALLATION

Go to "Control Panel" -> "Add/Remove Programs" and select VBdocman .NET. All work 
is done automatically.



5. TRIAL VERSION

Trial 14 day version of VBdocman comes without any limitations but
warning message is displayed every time a new documentation is compiled.



6. HOW TO REGISTER

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 .NET, you MUST register (buy). When you buy VBdocman .NET, you become
registered user.

Registered users will obtain all future minor versions until the next major version of VBdocman .NET for FREE. The next major version is when the first version number increases.

You can register at http://www.vbdocman.com via secure connection using ShareIt! service.
ShareIt! is well-known, leading shareware registration company.
It is quick and easy. Usually, you will have the full version in a while.

We accept Mastercard/Eurocard, Visa, American Express, and Diner's Club online. 
Alternatively, we support bank transfer/wire transfer, we accept Checks and Money Orders
through postal mail.

Immediately after the payment is accepted user receives e-mail with registration code. User can enter this code by pressing "REGISTER" button in main VBdocman dialog. If the code is valid, trial version becomes a full version immediately.

Please visit http://www.vbdocman.com/buy.htm.



7. CHANGES

In version 1.1
 1. Non-english character sets supported.
 2. Non-english Visual Studio .NET supported.
 3. Ability to remove line continuations in source code listings in documentation.
 4. Compilation progress dialog can be resized to better reading of messages.
 5. Some macros added to templates to allow translation of templates to other languages.
 6. Some problems with unrecognized comments fixed.
 7. Behavior of Apply button in Comment Editor fixed.
 8. $CHRn$ macro processing fixed.
 9. When using XML comments, <, >, &, ' and " characters are escaped automatically in the background within $CODE$ block.
 10. Processing of names of overloaded members is not case-sensitive now.



8. CONTACT

Home page and registration information: http://www.vbdocman.com

HELIXOFT 
Tomasikova 14
080 01 Presov
Slovak Republic


Contact person:
Peter Macej
peter@vbdocman.com
peter@helixoft.com
