Contact

Type Library Documentor

Installing the Explorer Context Items

This is probably the easiest way to use the documentor - after runnning:

	c:\tlbdoc -x

There will be a 'Document Type Library' item added to the Explorer context menu for files with the extensions .dll, .ocx and .tlb. Selecting the item will run the documentor and then compile and open the help file (assuming you have hcw in your PATH).

Running from the command line

	Usage  : TLBDOC <filename>
	Summary: Generates a help file from a type library
	Switches
		-c Automatically compile (HCW must be in PATH)
		-r Open Help file after compilation
		-x Install Explorer Context Items (for .dll, *.ocx and .tlb)
		-# Show version info

Run the program with no command line switches and it'll pop up a file open dialog.

Where is my help file?

Look in the tree below the directory containing TLBDOC.exe

Why on earth would I want to use this?

Good question!

Developers

Well the documentor has quite a lot to offer the developer - just point the documentor at your library and hey-presto you've got a help file for it. You'll notice a .txt file in the output directory - you can add your own notes here to each object, method, property and event in the library and they'll be included in the help file - they won't even be deleted the next time you run the documentor either. Since it's a nice little command line utility you can even include it in your makefile.

Anoraks, Nerds and the mildly curious

Have you got lots of OCXs installed on your machine and you've not got a clue what half of them do? Run the documentor and reveal the automation interface of classes you never knew existed! You might even find something useful.

What's this HCW thing then?

That's the MS help compiler - you probably knew that. If you've not got it on your system you can probably download it from the MS site.

HCW needs to be in your path if you want the documentor to automatically compile and open your help files. You can always open the .hpj file manually if it's not.

What's a type library and where would I find one?

No, sorry you can't use this program unless you know what a type library is! You'll find them most often in .dll, .ocx and .tlb files.

What's good and bad about the program

Good

We think this is a pretty cool little time-saver! And it's free.

Bad

Well, it only documents the OLE automation interfaces (those accessible through IDispatch). It was hacked together in a few hours and there's not much error checking in the code - if it doesn't work the chances are it won't tell you why.