Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles
(untagged)

The WTL Documentation Project

0.00/5 (No votes)
15 Jul 2000 1  
A framework in which to build a complete set of documentation for WTL. This is not complete, and will probably always be a work in progress.

Main Page   Class Hierarchy   File List   File Members  


Welcome
Overview
Revision History
Contributors
Acknowledments and Copyrights

Welcome

Since version 3.0 of the Windows Template Library was made available, many ATL developers have embraced it for its ATL GUI extensions and MFC style classes. WTL allows ATL developers to quickly integrate and/or extend many useful classes.

As of the early part of 2000, developers looking for documentation on the WTL had somewhat limited resources. There were a few good white papers and transcripts to provide insight, but as yet no comprehensive class reference.

We'd like to change that.

In June 2000, Ben Burnett posted the beginnings of a compiled HTML document compilation dealing with the nitty gritty of the classes and methods available in the WTL.  This documentation is the continuance of that initial posting.

We've taken a bit of a different approach this time. Since the WTL is quite an extensive library, it hardly seems possible for one pair of hands to deal with all the work that a complete reference would involve. We decided to draw up a framework in HTML that would allow us to present the classes involved, and then fill in the blanks.

We've changed the format from compiled HTML Help to on-line HTML, at least for now. When the project approaches completion, we'll make available a compiled HTML Help file for general consumption.  We felt it would be a bit wasteful to continually update a rather large file while classes remained undocumented.

We'd like to make this a project that we all can contribute to. As you browse through the class refs you'll see that there is a lot to do. If you've used one of the classes, or have some experience in deriving your own from an implementation template, and can hold your breath long enough to edit an HTML based page, we'd like to hear from you!

Whats in it for you?  Well, your name in the list of contributors, and maybe (someday) even a hat or a t-shirt.  "I WhiTtLed on the DoCk" or something catchy like that there. (Ed. note: cut back Tim's coffee rations)

At the outset, our main focus is in filling in the class references.  This shouldn't stop people from sumitting stand alone articles - but for those of you who have an isolated bit of code that illustrates some functionality but doesn't quite rate an article with project, here's your chance. There's lots of room for sample code.

Contact us at wtlDocs@CodeProject.com

Overview

The components of the WTL fall into several categories.

Most emphasis has been placed on providing wrappers for the Windows common dialogs and controls, along with GDI objects and extensive support for device contexts.

The library also contains classes dealing with application support (based on CComModule), data exchange for controls, printing support, and even a few MFC ports (including good ol' CString!), and the OpenGL wgl support functions!

All of the classes and stand alone methods are in the WTL namespace unless otherwise noted.

This documentation is organized with a Class Heirarchy, and also with links to a File List page that outlines what classes etc. are defined in the various headers.

Contributors

Ben Burnett Provided the original concept and initial annotations.
Tim Deveaux Assisted in organizing the on line HTML project.

Revision history

June 2000 Initial article posted on site by Ben Burnett
July 2000 Second phase (this collection) begun.  Original annotations ported by Ben Burnett.

Acknowledgements and Copyrights

doxygen The documentation files were originally generated using doxygen - an open source source documentation system for C, C++ and IDL, which can also be configured to extract the code-structure from undocumented source files. It is covered by the GNU Public licence.

The Windows Template Library is Copyright   � 1997-2000 Microsoft Corporation, all rights reserved.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here