Doc-O-Matic

Examples

Examples on this page all show the same documentation, rendered with different templates. Doc-O-Matic comes with templates for Visual Studio 2010, Visual Studio 2008, Visual Studio 2005, Embarcadero RAD Studio XE, Embarcadero RAD Studio 2010, CodeGear Delphi 2007, Visual Studio 2003 and more. Standard templates include configurations for direct Help integration, a Web Help configuration for online publishing in the same style and a print configuration for PDF output.

Visual Studio 2010 - Help 3 Visual Studio 2008 - Help 2 Visual Studio 2005 - Help 2

The first screen shot shows the new Visual Studio 2010 Help style as produced by the Visual Studio 2010 template in a Help 3 context. It visually integrates into the MSDN library documentation and includes features like the tabbed syntax sections, multi-language syntax output and automatic linking within the project and into the library documentation.

The middle screen shot shows the same content styled for Visual Studio 2008 integration displayed in the Help 2 browser. This style includes expandable sections and automatic anchors for the See Also section and "Top" links. Help users can collapse and expand all collapsable sections by clicking the Collapse All/Expand All link in the header, the collapsed states are stored across sessions.

The last screen shot uses the Visual Studio 2005 template, again using the same source.

Source Code

Doc-O-Matic understands how developers document source code. The following source comment is very easy to read due to Doc-O-Matic's ability to understand natural comments.

If you like XML Doc or JavaDoc, Doc-O-Matic does support both equally well and all three styles are supported when writing source comments through the integrated editor back to the source.

//  Description:
//      Use the find function to locate a string S in the string list.
//      Only use this function if the string list is sorted, to locate
//      a string in a non-sorted string list use IndexOf.
//  See Also:
//      IndexOf, Sort, Sorted
//  Arguments:
//      S -     The string to be located.
//      Index - The index of S is returned through this parameter if it
//              was found. It is not guaranteed that Index is not
//              modified, even if the string isn't found.
//  Return Value:
//      TRUE if the string could be found in the string list,
//      FALSE otherwise.
//  Summary:
//      Locates a string in the string list.
bool Stringlist::Find(const char *S, int &Index)
{
   [...]
}
Copyright © 2000-2010 by toolsfactory software inc. All rights reserved.