kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ENH: Adding links to web resources and FAQ to SEE ALSO section. This addresses bug #3757.

This commit is contained in:
Brad King 2006-10-05 10:55:37 -04:00
parent e1799a5f88
commit 1bdebd7da6
1 changed files with 34 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
Source/cmDocumentation.cxx
View File

@ -69,12 +69,33 @@ static const cmDocumentationEntry cmDocumentationGeneratorsHeader[] =
};
//----------------------------------------------------------------------------
const cmDocumentationEntry cmDocumentationMailingList[] =
static const cmDocumentationEntry cmDocumentationStandardSeeAlso[] =
{
{0,
"For help and discussion about using cmake, a mailing list is provided "
"at cmake@www.cmake.org. Please first read the full documentation at "
"http://www.cmake.org before posting questions to the list.", 0},
"The following resources are available to get help using CMake:", 0},
{"Home Page",
"http://www.cmake.org",
"The primary starting point for learning about CMake."},
{"Frequently Asked Questions",
"http://www.cmake.org/Wiki/CMake_FAQ",
"A Wiki is provided containing answers to frequently asked questions. "},
{"Online Documentation",
"http://www.cmake.org/HTML/Documentation.html",
"Links to available documentation may be found on this web page."},
{"Mailing List",
"http://www.cmake.org/HTML/MailingLists.html",
"For help and discussion about using cmake, a mailing list is provided at "
"cmake@cmake.org. "
"The list is member-post-only but one may sign up on the CMake web page. "
"Please first read the full documentation at "
"http://www.cmake.org before posting questions to the list."},
{0,
"Summary of helpful links:\n"
" Home: http://www.cmake.org\n"
" Docs: http://www.cmake.org/HTML/Documentation.html\n"
" Mail: http://www.cmake.org/HTML/MailingLists.html\n"
" FAQ: http://www.cmake.org/Wiki/CMake_FAQ\n"
, 0},
{0,0,0}
};
@ -545,6 +566,7 @@ void cmDocumentation
//----------------------------------------------------------------------------
void cmDocumentation::SetSeeAlsoList(const cmDocumentationEntry* also)
{
this->SeeAlsoSection.clear();
this->SeeAlsoString = ".B ";
for(const cmDocumentationEntry* i = also; i->brief; ++i)
{
@ -554,8 +576,13 @@ void cmDocumentation::SetSeeAlsoList(const cmDocumentationEntry* also)
cmDocumentationEntry e = {0, 0, 0};
e.brief = this->SeeAlsoString.c_str();
this->SeeAlsoSection.push_back(e);
for(const cmDocumentationEntry* i = cmDocumentationStandardSeeAlso;
i->brief; ++i)
{
this->SeeAlsoSection.push_back(*i);
}
e.brief = 0;
this->SeeAlsoSection.push_back(e);
this->SeeAlsoSection.push_back(e);
}
//----------------------------------------------------------------------------
@ -1170,7 +1197,7 @@ void cmDocumentation::CreateFullDocumentation()
this->AddSection("Standard CMake Modules", &this->ModulesSection[0]);
}
this->AddSection("Copyright", cmDocumentationCopyright);
this->AddSection("Mailing List", cmDocumentationMailingList);
this->AddSection("See Also", cmDocumentationStandardSeeAlso);
}
//----------------------------------------------------------------------------
@ -1208,11 +1235,7 @@ void cmDocumentation::CreateManDocumentation()
}
this->AddSection("COPYRIGHT", cmDocumentationCopyright);
this->AddSection("MAILING LIST", cmDocumentationMailingList);
if(!this->SeeAlsoSection.empty())
{
this->AddSection("SEE ALSO", &this->SeeAlsoSection[0]);
}
this->AddSection("SEE ALSO", &this->SeeAlsoSection[0]);
this->AddSection("AUTHOR", cmDocumentationAuthor);
}