summaryrefslogtreecommitdiff
path: root/Source/cmDocumentation.h
diff options
context:
space:
mode:
authorAlex Neundorf <neundorf@kde.org>2012-06-21 23:06:08 +0200
committerAlex Neundorf <neundorf@kde.org>2012-06-21 23:06:08 +0200
commit38df155dd394efd45dff887028b2e1a4c0969b03 (patch)
tree3f4d3c0c989321d01f1cfa1a4c2d8e6d045741ff /Source/cmDocumentation.h
parente6a935f39b2d15677830fdba8090d8c725165ca9 (diff)
downloadcmake-38df155dd394efd45dff887028b2e1a4c0969b03.tar.gz
documentation: preparation for making the man section configurable
This patch adds a man section number, which is then used by the DocumentationFormatterMan. The section number is right now always 1, detecting this from the file name will be the next step. Alex
Diffstat (limited to 'Source/cmDocumentation.h')
-rw-r--r--Source/cmDocumentation.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h
index a3f8e44418..3fcea8fc9d 100644
--- a/Source/cmDocumentation.h
+++ b/Source/cmDocumentation.h
@@ -108,7 +108,7 @@ public:
* Print documentation in the given form. All previously added
* sections will be generated.
*/
- void Print(Form f, std::ostream& os);
+ void Print(Form f, int manSection, std::ostream& os);
/**
* Print documentation in the current form. All previously added
@@ -190,7 +190,7 @@ public:
std::vector<cmDocumentationEntry>& commands,
cmake* cm);
private:
- void SetForm(Form f);
+ void SetForm(Form f, int manSection);
void SetDocName(const char* docname);
bool CreateSingleModule(const char* fname,
@@ -247,11 +247,12 @@ private:
struct RequestedHelpItem
{
- RequestedHelpItem():HelpForm(TextForm), HelpType(None) {}
+ RequestedHelpItem():HelpForm(TextForm), HelpType(None), ManSection(1) {}
cmDocumentationEnums::Form HelpForm;
cmDocumentationEnums::Type HelpType;
std::string Filename;
std::string Argument;
+ int ManSection;
};
std::vector<RequestedHelpItem> RequestedHelpItems;