~ubuntu-branches/ubuntu/jaunty/cmake/jaunty-security

« back to all changes in this revision

Viewing changes to Source/cmDocumentation.h

  • Committer: Bazaar Package Importer
  • Author(s): A. Maitland Bottoms
  • Date: 2006-06-18 16:34:11 UTC
  • mfrom: (1.4.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20060618163411-pi234s3v6jwlcmof
Tags: 2.4.2-1
* New upstream release (Closes: #338324)
* Put cmake .vim files into /usr/share/vim/addons/plugin/
  where they can be used. (Closes: #366663)
* Install cmake-mode.el so it can be used. (Closes: #366664)
* Ensure cmake FindKDE locates KDE libraries on Debian
  based distributions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
  Program:   CMake - Cross-Platform Makefile Generator
4
4
  Module:    $RCSfile: cmDocumentation.h,v $
5
5
  Language:  C++
6
 
  Date:      $Date: 2004/04/14 18:25:43 $
7
 
  Version:   $Revision: 1.13 $
 
6
  Date:      $Date: 2006/04/14 03:15:48 $
 
7
  Version:   $Revision: 1.15 $
8
8
 
9
9
  Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
10
10
  See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
25
25
public:
26
26
  cmDocumentation();
27
27
  
 
28
  ~cmDocumentation();
28
29
  // High-level interface for standard documents:
29
30
  
30
31
  /** Types of help provided.  */
31
 
  enum Type { None, Usage, Single, List, Full, HTML, Man, Copyright, Version };
 
32
  enum Type { None, Usage, Single, SingleModule, List, ModuleList,
 
33
              Full, HTML, Man, Copyright, Version };
32
34
  
33
35
  /**
34
36
   * Check command line arguments for documentation options.  Returns
94
96
  
95
97
  /** Clear all previously added sections of help.  */
96
98
  void ClearSections();  
 
99
  
 
100
  /** Set cmake root so we can find installed files */
 
101
  void SetCMakeRoot(const char* root)  { this->CMakeRoot = root;}
97
102
private:
98
103
  void PrintSection(std::ostream& os,
99
104
                    const cmDocumentationEntry* section,
121
126
  void PrintColumn(std::ostream& os, const char* text);
122
127
  void PrintHTMLEscapes(std::ostream& os, const char* text);
123
128
 
 
129
  bool CreateSingleModule(const char* fname, const char* moduleName);
 
130
  bool CreateModulesSection();
124
131
  bool PrintCopyright(std::ostream& os);
125
132
  bool PrintVersion(std::ostream& os);
126
133
  bool PrintDocumentationList(std::ostream& os);
 
134
  bool PrintModuleList(std::ostream& os);
127
135
  bool PrintDocumentationSingle(std::ostream& os);
 
136
  bool PrintDocumentationSingleModule(std::ostream& os);
128
137
  bool PrintDocumentationUsage(std::ostream& os);
129
138
  bool PrintDocumentationFull(std::ostream& os);
130
139
  bool PrintDocumentationHTML(std::ostream& os);
149
158
  std::vector<cmDocumentationEntry> DescriptionSection;
150
159
  std::vector<cmDocumentationEntry> OptionsSection;
151
160
  std::vector<cmDocumentationEntry> CommandsSection;
 
161
  std::vector<cmDocumentationEntry> ModulesSection;
152
162
  std::vector<cmDocumentationEntry> GeneratorsSection;
153
163
  std::vector<cmDocumentationEntry> SeeAlsoSection;
154
164
  std::string SeeAlsoString;
155
165
  std::string SingleCommand;
156
 
 
 
166
  std::string SingleModuleName;
 
167
  std::string CMakeRoot;
 
168
  std::vector< char* > ModuleStrings;
157
169
  std::vector< const char* > Names;
158
170
  std::vector< const cmDocumentationEntry* > Sections;
159
171
  Form CurrentForm;