Compile Options

Go to Add-Ins -> VBdocman menu or press VBdocman button on standard toolbar. Options dialog appears. Set Compile tab.

In the left frame specify which members (classes, forms, methods, events, ...) go to the compilation. Options serve as a filter here.

Option Meaning
Non-commented Compile also members without special VBdocman comments. The default comment is then assumed. Object acts as if there was a comment added using Add VBdocman Comment function from pop-up menu and nothing else was added.
Public Include public members.
Private Include private members.
Friend Include friend members.
Classes Include topics for classes (objects). If unchecked, only topics for classes won't be generated, but their members such as methods or events can still be included.
Forms Include topics for forms. If unchecked, only topics for forms won't be generated, but their members such as methods or events can still be included.
Standard Modules Include topics for standard modules. If unchecked, only topics for standard modules won't be generated, but their members such as functions or variables can still be included.
Methods/Functions Include topics for methods and functions.
Properties Include topics for properties.
Events Include topics for events.
Variables Include topics for variables.
Constants Include topics for constants.

In the right frame there is a list of all available modules in current project. Check those which you want to compile. Unchecked module acts as if it would not exist in the VB project, so no topics for module nor for its functions, methods, etc. will be created.

There is also a check-box Add Help Context IDs. When checked, the context ID numbers are automatically generated and written into source code during compilation. Therefore if you are not sure, you should make backup copies of your source files before compilation. Help file of VB project is automatically set to generated documentation only if this option is checked.

The check-box Write to "Description" attribute specifies whether the description is automatically written into Description attribute during compilation. Description attribute is hidden in source code and cannot be seen in VB IDE. You can access it from menu Tools -> Procedure Attributes... or you can see it if you open VB source file in Notepad. Information in this attribute is compiled into resulting dll. So if you create your ActiveX control in this way and use it in other VB project, you can see that description in Properties window and in Object Browser as well. See also Creating and Using Context Sensitive Help.


Send feedback to Helixoft
© 2000-2005 Helixoft. All rights reserved.