Source/cmDocumentationFormatterUsage.h

   1 /*============================================================================
   2   CMake - Cross Platform Makefile Generator
   3   Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
   4
   5   Distributed under the OSI-approved BSD License (the "License");
   6   see accompanying file Copyright.txt for details.
   7
   8   This software is distributed WITHOUT ANY WARRANTY; without even the
   9   implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10   See the License for more information.
  11 ============================================================================*/
  12 #ifndef _cmDocumentationFormatterUsage_h
  13 #define _cmDocumentationFormatterUsage_h
  14
  15 #include "cmDocumentationFormatterText.h"
  16
  17 /** Class to print the documentation as usage on the command line.  */
  18 class cmDocumentationFormatterUsage : public cmDocumentationFormatterText
  19 {
  20 public:
  21   cmDocumentationFormatterUsage();
  22
  23   virtual cmDocumentationEnums::Form GetForm() const
  24                                      { return cmDocumentationEnums::UsageForm;}
  25
  26   virtual void PrintSection(std::ostream& os,
  27                     const cmDocumentationSection& section,
  28                     const char* name);
  29 };
  30
  31 #endif