Copyright: Written by Eddie Juden (1994)
Citation: Written by Eddie Juden (1994)


Visual Basic Source Code to Document
Visual Basic Source Code to Document (6.0)

Eddie Juden

CServe: 72154,1324

Whats New!

Overview

Main Dialog

Remove Form Descriptions

Table of Contents

Variable Index

Global, Constants, Structure, and Object Variable Indexes

Construct Document for Book Option

Count Usage of Subs and Functions

Menu Bar

ToolBar

Bookmarks

View/Print/Copy Individual Sub or Function

Format Sub and Function Headings

Format Rem'med Statements

Format Normal Text

Register


 Remove Form Descriptions

Selecting this option will remove all form and control descriptions from all FORM files.  This will decrease the size of your document substantially.


 Count Usage of Subs and Functions

Selecting this option will go through every SUB and FUNCTION in the FORM and BASIC files that you have selected and count the number of times each SUB and FUNCTION is called.  This is a great way to find the FUNCTIONs or SUBs that are using up space.  NOTE:  If you are using this option to select FUNCTIONs or SUBs for removal, be sure to select all FORM and BASIC files! (>> Button)


 Add Table of Contents

Selecting this option will create a Table of Contents for your project.  This is probably the best feature of this program.  It will list all SUBs and FUNCTIONs and the page that they may be located.  A Great Tool for Debugging!


Index
Variable Index

Selecting the Variable Index option will create an index of ALL the variables used within your program, and what pages to refer to where they are used.

Warning:  Using this feature may take a long time depending upon the system.  Some systems may exhaust their resources before the task is complete.


Useful Indexes

You may include four other indexes if you wish.

The Structure Index option will create an index of all Structures (TYPE) within your program and what pages to refer to where they are declared.

The Global Index option will create an index of all Global Variables within your program and what pages to refer to where they are used.

The Constant Index option will create an index of all Const variables within your program and what pages to refer to where they are used.

The Object Index option will create an index of all Object variables within your program and what pages to refer to where they are used.


 Print When Finished

Selecting this option will automatically print your completed document once the document is created.  Depending upon your computer and the size of your project, document creation may take quite a while.  Using this feature will allow you to let the program run unattended.


 Author

The name entered here will be placed in the header of every page as well as on the title page.


Overview

IMPORTANT: All of the FORM and BASIC files of the Project that you will be basing this Document on MUST be saved as TEXT.  (The FORM and BASIC files will not be changed in any way by this Template!)

This Microsoft Words for Windows Template will ask you to select a Visual Basic for Windows .MAK file and will then create a document based on the FORM and BASIC files contained within.  The finished document will be formatted with all SUB's and FUNCTIONs highlighted, all Rem'med statements will be formatted in italics, all SUBs and FUNCTIONs will be checked for total usage by your program (if option selected), and a Table of Contents will be created marking all . FORM and BASIC files, SUBs, and FUNCTIONs.  The program will also allow you to create up to five indexes based upon your .MAK file.

You may change the format of the Sub and Function Headings, the Rem'med statements, and the Normal text either before document creation or after.


Register Program

** Push  the PRINT button to print this form **

Mail to:

Eddie Juden

P.O. Box 900062

Plano, TX 75074-0062

Please include your check made payable to Eddie Juden for $49.00 per copy/seat.

Thank you for registering for this program.  People like yourself make programming worthwhile!

Name:

Company:

Address:

City, State, Zip:

Country (if not USA):

Where did you obtain copy of program?

Compuserve ID (if member):

Number of copies requested:

Comments:


Menu Bar

After you have created the document, you may format the Headings, the Rem'med statements, or the Normal Text.  To change any of the formats, select the menu item from under the FORMAT selection on the Main Menu Bar.


Tool Bar

After you have created the document, you may format the Headings, the Rem'med statements, or the Normal Text.  To change any of the formats, select either of the Format buttons from the Toolbar.

You may use the Goto Sub/Function button to quickly jump to a specific Sub or Function within your document.

By selecting the View/Print/Copy Sub/Function button, you may copy a specific sub or function to the clipboard for pasting in Visual Basic or to a separate VB2Doc document that may be acted upon separately.  You may also print out separate Subs or Functions.


Formatting Subs and Functions
Formatting the Subs and Function Headings

See Also

You may change the format of the Subs and Function headings at any time.  You may change the format before the document creation by choosing one of the FORMAT buttons on the Main Dialog, or you may change the format after the creation of the document by choosing the option under the FORMAT selection on the Menu Bar, or by selecting one of the Format buttons from the Toolbar.


Formatting Rem'med Statements
Formatting the Rem'med Statements

See Also

You may change the format of the Rem'med statements at any time.  You may change the format before the document creation by choosing one of the FORMAT buttons on the Main Dialog, or you may change the format after the creation of the document by choosing the option under the FORMAT selection on the Menu Bar, or by selecting one of the Format buttons from the Toolbar.


Formatting Normal Text
Formatting the Normal Text

See Also

You may change the format of the Normal Text at any time.  You may change the format before the document creation by choosing one of the FORMAT buttons on the Main Dialog, or you may change the format after the creation of the document by choosing the option under the FORMAT selection on the Menu Bar, or by selecting one of the Format buttons from the Toolbar.


Formatting Subs and Functions

Formatting Rem'med Statements

Formatting Normal Text


Main Dialog

Click anywhere on the form that you would like more information about.


BookMarks

All Sub and Function names are saved as bookmarks.  You may easily scroll to any Sub or Function by selecting the name of the Sub or Function name from the bookmarks form.  Select Bookmarks from the Tools menu or you may select the Bookmarks Button on the Toolbar.


View/Print/Copy Individual Sub or Function

You may select an individual Sub or Function from your document to view, print, or copy.

When selecting an individual Sub or Function to view, the Sub or Function will be installed into its own document window that may be modifed separately based on its own instance of the VB2Doc template.

You may use the Copy feature to automatically select an individual Sub or Function from your document to Copy to the Clipboard for pasting into your code or other Microsoft Windows Application.


 Whats New

Whats New for Version 6.0

Fully compataible with Microsoft Word for Windows 6.0.

You have the option creating the document for use as a Book or Whitepaper.
The Book option will place the page number of all odd pages in the upper right corner and the page number of all even pages in the upper left corner, as well as increase the size of the inside margins to make room for the binder.

All Sub and Function names are now bookmarked.  You may go to any Sub or Function quickly by selecting Bookmarks from the Tools menu or by selecting the Bookmarks Button from the ToolBar

You may open up an individual Sub or Function into its own window which will be a completely different document based upon a new instance of the VB2Doc template.  All features of this program will be available to the new document separately.

You may print your complete document or you may print only a specific Sub or Function.

You may change the FONT  for any part of your document either before or after the document is created.

The program will create up to five different indexes from your source code.

Variable Index:  The program will create an index of all your variables and show which pages they are used.

Global Variable Index:  The program will create an index of all your Global Variables and show which pages they are used.

Structure Index:  The program will create an index of all your Structures (TYPE) and show which pages they are used.

Const Index:  The program will create an index of all your Constant Variables and show which pages they are used.

Object Index:  The program will create an index of all your Object Variables and show which pages they are used.


Construct Document for use as a Book option

Selecting the Construct Document as Book option will place the page number of even pages on the upper left margin, and the page number of odd page on the upper right margin.  It will also increase the left margin of each page to make room for the binder.


> Button

Pressing this button, selects the highlighted files from the left list box and places it in the right list box, which are the files that will be used.


>> Button

Pressing this button will select all .the files from the left list box, all files will then be used.


< Button

Pressing this button will remove a selected file from the right list box (which are the files that the program will use).


Files to Select From

This list box contains the names of all the FORM and BASIC files included in your .MAK file.


Selected Files

This listbox contains the FORM and BASIC files that you have already selected using the > or >> buttons.  The document will be created with these files.


Done Button

After selecting the FORM and BASIC files from the Files to Select listbox with the > or >> buttons, selecting the Done Button will start the creation of the Document.


Template

A Template is used by Microsoft Word for Windows to store all programming for a Document based on that Template.  VB2Doc is the Template that all your Visual Basic Templates will be based on.


Global Index

Selecting this option will create an index of all the Global variables within your program and where they are used.


Constant Index

Selecting this option will create an index of all the Const variables within your program and where they are used.


Structure Index

Selecting this option will create an index of all the Structures (TYPE) within your program and where they are declared.


Object Index

Selecting this option will create an index of all Object Variables (SET) within your program and where they are used.


Variable Index

Selecting this option will create an full index of All the variables within your program and where they are used.


Lock Screen

Selecting this option will stop all screen updating until the document is created.  This will significantly speed up the creation of the document.


Construct Document as Book

You have the option creating the document for use as a Book or Whitepaper.
The Book option will place the page number of all odd pages in the upper right corner and the page number of all even pages in the upper left corner, as well as increase the size of the inside margins to make room for the binder.