summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentationFormatter.h
Commit message (Collapse)AuthorAgeFilesLines
* Drop all documentation formatters except UsageBrad King2013-10-161-21/+9
| | | | | | | | We now need only the Usage formatter to support command-line options that print basic usage, and the supporting indented=>preformatted markup processor to support CMake message formatting. Drop all other documentation formatters and move the remaining code up into the top cmDocumentationFormatter class.
* Teach --help-* options to load documentation from .rst filesBrad King2013-10-161-4/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Install the Help directory next to Modules to make it available in CMake distributions. Use cmRST to read Help .rst documents and print them as help output. Add options --help-manual-list --help-manual to list available manuals or print one of them. Implement the options --help-commands --help-modules --help-policies --help-properties --help-variables by mapping to the corresponding manual page. Implement the options --help-command-list --help-module-list --help-policy-list --help-property-list --help-variable-list by globbing the available Help .rst documents of the corresponding type and reading their titles. Implement the options --help-command --help-module --help-policy --help-property --help-variable by globbing the matching Help .rst document(s) and printing them.
* Drop "full" documentation output typesBrad King2013-10-151-2/+2
| | | | | | | | | | | | | | | | We will no longer support full documentation generation from executables and will instead generate documentation with other tools. Disable (with a warning left behind) the command-line options: --copyright --help-compatcommands --help-full --help-html --help-man Drop supporting code. Drop manual sections generation from executables. Remove internal documentation construction APIs. Drop unused sections See Also, Author, Copyright, Compat Commands, Custom Modules.
* Add reStructuredText (RST) documentation formatterBrad King2013-10-151-1/+1
| | | | | | | | | | | | | | | | | | | | Temporarily add a RST formatter to convert builtin documentation to .rst source files. This will be removed shortly after we use it to convert documentation. Teach the RST formatter to: * Output preformatted blocks as reStructuredText "::" literal blocks. * Output option lists as bullet lists with option names enclosed in reStructuredText ``literal`` quoting. * Output individual documentation objects (commands, variables, etc.) in separate .rst files organized in directories by type. Replace references to cmVersion::GetCMakeVersion() in builtin documentation with the literal placeholder "|release|" that will be defined as a substitution later.
* cmake: Add --help-policy-list optionBrad King2013-10-151-1/+1
| | | | | All the other --help-<item> options have a corresponding option --help-<item>-list. Add one for --help-policy.
* Doxygen: Fix warnings.Nicolas Despres2011-10-231-1/+1
|
* Remove trailing white-spaces.Nicolas Despres2011-10-231-5/+5
|
* Convert CMake to OSI-approved BSD LicenseBrad King2009-09-281-14/+9
| | | | | | | This converts the CMake license to a pure 3-clause OSI-approved BSD License. We drop the previous license clause requiring modified versions to be plainly marked. We also update the CMake copyright to cover the full development time range.
* ENH: Improve generated documentation formattingBrad King2008-10-101-1/+3
| | | | | | | | | | | | Applying patch provided in issue #7797. Fixes to man-pages: - Character '-' must be espaced as '\-' - Surround preformatted text with '.nf' and '.fi' to adjust filling - Give every page a NAME section for indexing by mandb - Pass the man page filename without extension to .TH in its header Also added a title to the HTML header.
* ENH: Fix generated documentation internal links.Brad King2008-05-051-0/+3
| | | | | | | - Previously all links started in 'command_' which led to conflicts and was confusing for non-command items. - Use a per-section name that is meaningful to humans. - Fix link id names to be valid HTML.
* ENH: add master index into html full helpBill Hoffman2008-03-051-0/+3
|
* ENH: add --help-policies and --help-policy command line optionsKen Martin2008-03-041-1/+1
|
* ENH: add support for creating the documentation in docbook formatAlexander Neundorf2008-02-191-1/+1
| | | | | | | | (http://www.oasis-open.org/docbook/xml/4.2/), which users can then convert to other formats. Tested with meinproc from KDE, which generates HTML pages which look good. Alex
* ENH: some more cleanup, fixes, and patch for HTML outputKen Martin2007-10-241-4/+4
|
* ENH: change to make the documentation class more generic, about halfway ↵Ken Martin2007-10-221-1/+3
| | | | there, also provides secitons for Variables now
* ENH: add new help option --help-custom-modules, which generatesAlexander Neundorf2007-09-191-1/+1
| | | | | | | | | | | documentation for all modules found in CMAKE_MODULE_PATH, which currently has to be specified via -D, this can later on be improved e.g. by reading a special (to-be-created) file like CMakeFiles/ModulePath.cmake in the build tree so that running cmake help in the build tree of a project will always give you the current module path. (This could actually also help IDEs which would like to support cmake for projects...) Alex
* COMP: fix warning about unused parametersAlexander Neundorf2007-09-191-2/+2
| | | | Alex
* STYLE: move the code for the different formats of the generated help intoAlexander Neundorf2007-09-191-0/+62
their own classes, making cmDocumentation smaller and also making it easier to eventually add another format Alex
generated by cgit v0.12 at 2024-10-17 12:28:35 (GMT)