Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

6.5. Miscellaneous

6.5.1. How do you document the source code?
6.5.2. What do you use to produce general documentation?
6.5.3. How can I edit and/or contribute to the VCF's documentation?
6.5.4. Is Doxygen free? Is it easy to use like javadoc?
6.5.5. What is the VCF's performance relative to MFC?
6.5.6. What is the size/memory footprint difference of an application written with VCF vs MFC?
6.5.7. Is there a way to statically link to VCF rather then use the dlls?
6.5.8. If I have written and application in MFC can I still use the VCF libraries in this app? How hard/easy is it to integrate VCF code with other frameworks or vice-versa?
6.5.9. How long will this project last? What happens in the original or current developers lose interest?
6.5.10. Is the VCF help documentation integrated with the MSDN help for Visual Studio users?
6.5.1.

How do you document the source code?

Source code documentation is done through comments in the source headers using Javadoc notation (such as @author, @version, @return, @param, etc).

The documentation itself is produced by using doxygen on all the source files.

6.5.2.

What do you use to produce general documentation?

The general documentation (which is what your reading right now) is produced by using docbook. All the documentation is written in xml conforming to the docbook DTD. It is then transformed by various docbook xsl stylesheets to produce the online html and HTML Help files.

6.5.3.

How can I edit and/or contribute to the VCF's documentation?

The core documentation is located in a series of .xml files in the vcf/docs directory. To add documentation to the VCF you should edit these files. Please see the section on "Documentation Standards and Generation" (section 1.6.4.2).

6.5.4.

Is Doxygen free? Is it easy to use like javadoc?

Yes, Doxygen is free, and supports most of the basic javadoc tags (which is why I use it).

6.5.5.

What is the VCF's performance relative to MFC?

VCF performance is equivalent to MFC, and adds a noumber of "for free" features, like double buffering, and layout, that you typically have to write by hand in MFC. In addition the number of calls from when a native Win32 event is received to getting to an event handler within the framework is often much less, as MFC adds a number of "extra" handling between the time the event is fired and is received by the developers callback.

6.5.6.

What is the size/memory footprint difference of an application written with VCF vs MFC?

In terms of memory used by an application, the VCF uses more memory. For small utility applications, or size critical applications, this might make a difference, but for larger "desktop" applications, the difference becomes much less as the application itself takes a lot of memory due to features and/or complexity regardless of using MFC or the VCF.

The runtime binary libraries for the VCF are under 3MB in size (this includes the FoundationKit, GraphicsKit, and ApplicationKit).

6.5.7.

Is there a way to statically link to VCF rather then use the dlls?

Yes, you can use the VCF as a static library.

6.5.8.

If I have written and application in MFC can I still use the VCF libraries in this app? How hard/easy is it to integrate VCF code with other frameworks or vice-versa?

6.5.9.

How long will this project last? What happens in the original or current developers lose interest?

6.5.10.

Is the VCF help documentation integrated with the MSDN help for Visual Studio users?

Yes, the win32 installer executable can integrate the VCF's documentation into your MSDN collection.

   Comments or Suggestions?    License Information