// $Id: Example.hh,v 1.3 2003/08/11 20:04:35 rlv Exp $
// $Source: /h/cm/style/examples/Example.hh,v $
// Copyright 2001-2003 YoyoDyne, all rights reserved.
//

#include ...

/**
 * This is an example class provided to illustrate how to document at the
 * class level. This section is filled with a high level description of
 * the purpose of this class. Examples can be shown here for a class
 * with a small number of simple methods. If the methods are complex,
 * the examples can be done before the methods themselves.
 *
 * @author YoyoDyne/Anti-gravity
 * @version 001.00
 */
public class Example
{
public:
  /**
   * {A description of this method, potentially including an example}
   *
   * @param p1 {A one line description of parameter p1}
   * ...
   */
  void
  method(int p1);

private:
  /**
   * A multiline description of
   * a field.
   */
  Hashtable ht;

  /** A oneline description of a field. */
  private ArrayList al;

}
// End of File.