Source Code Example

Output Examples

So see what Doc-O-Matic generates from your source click here.

Doc-O-Matic understands how developers document source code. The following source comment is very good to read due to Doc-O-Matic's ability to understand naturally formed comments. Forget about the times where it was necessary to use tags - if you don't like them.

If you do like XMLDoc or JavaDoc, no problem! 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)
{
   [...]
}

The XMLDoc version:

//  <remarks>
//      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.
//  </remarks>
//  <seealso cref="IndexOf"/><seealso cref="Sort"/>
//  <seealso cref="Sorted"/>
//  <param name="S">The string to be located.</param>
//  <param name="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.</param>
//  <retval name="TRUE">if the string could be found in the
//             string list.</retval>
//  <retval name="FALSE">otherwise.</retval>
//  <summary>Locates a string in the string list.</summary>

bool Stringlist::Find(const char *S, int &Index)
{
   [...]
}

The JavaDoc version:

// Locates a string in the string list. 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.                
// @param S        The string to be located.
// @param Index    The index of S is returned through 
//                 parameter if it was found. It is not 
//                 guaranteed that Index is not modified, 
//                 even if the string isn't found.
// @retval TRUE    if the string could be found in the 
//                 string list,
// @retval FALSE   otherwise.
// @see            IndexOf
// @see            Sort
// @see            Sorted

bool Stringlist::Find(const char *S, int &Index)
{
   [...]
}

Why not go ahead and try Doc-O-Matic right now?