Source/cmDocumentationFormatterUsage.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmDocumentationFormatterUsage.h,v $
   5   Language:  C++
   6   Date:      $Date: 2007-10-22 16:48:39 $
   7   Version:   $Revision: 1.2 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef _cmDocumentationFormatterUsage_h
  18 #define _cmDocumentationFormatterUsage_h
  19
  20 #include "cmDocumentationFormatterText.h"
  21
  22 /** Class to print the documentation as usage on the command line.  */
  23 class cmDocumentationFormatterUsage : public cmDocumentationFormatterText
  24 {
  25 public:
  26   cmDocumentationFormatterUsage();
  27
  28   virtual cmDocumentationEnums::Form GetForm() const
  29                                      { return cmDocumentationEnums::UsageForm;}
  30
  31   virtual void PrintSection(std::ostream& os,
  32                     const cmDocumentationSection& section,
  33                     const char* name);
  34 };
  35
  36 #endif