summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentation.cxx
Commit message (Collapse)AuthorAgeFilesLines
* man documentation: detect man section from the given filenameAlex Neundorf2012-06-211-14/+33
| | | | | | | E.g. if you say cmake --help-custom-modules mymodules.7 cmake will now put section 7 into the generated manpage. Alex
* documentation: preparation for making the man section configurableAlex Neundorf2012-06-211-5/+6
| | | | | | | | 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
* Try to fix compile error on Win32-vs70Eric NOULARD2012-02-181-3/+4
|
* Suppress unecessary (now empty) doc sectionsEric NOULARD2012-02-181-2/+0
|
* Dynamically add documentation section specified in documented script.Eric NOULARD2012-02-181-3/+18
| | | | Modify CPackDeb and CPackRPM as an example
* Fix non existent std::string::clear on VS6Eric NOULARD2012-02-141-2/+2
|
* Create getDocumentedModulesListInDir which may be used in other context.Eric NOULARD2012-02-141-0/+55
| | | | | This should makes it easier to use the same "documented module" techniques for CTest, CMake or user module.
* Make the load of script documentation more efficient and dynamic.Eric NOULARD2012-02-141-2/+18
| | | | | | | | CPack help will be searched in any CPack*.cmake file located near to CPack.cmake file. The script files is parsed iff the first line begin with ##section. Moreover the documentation section name is specified on the remaining part of the line minus the space immediately following ##section.
* Fix potential bad memory access, thanks to EikeEric NOULARD2012-01-311-1/+1
|
* Suppress unused var, beautify code, avoid 1 extra newline.Eric NOULARD2012-01-241-18/+25
| | | | | | There remains extra newlines in text Formatter output but the parser does not seem to be the culprit. The formatter should be.
* CPack Documentation extraction from CMake script begins to workEric NOULARD2012-01-221-32/+108
| | | | | | | | | | - Enhance extract doc parser. Seems robust now. The legacy module documentation parser works as before ignoring the new markup. - Proof of concept for CPack (generic), CPack RPM and CPack Deb generator for macro and variables. Try cpack --help-command and cpack --help-variables
* Implement simple CMake script comment markup language.Eric NOULARD2012-01-221-0/+171
| | | | | | | | | The language is very simple. It use ##<keyword> special comment which opens a structured documentation block and ##end closes it. This may be used to extract documentation for macro as 'command' and 'variables' such that cpack --help-command and --help-variable does parse builtin modules files (CPack.cmake, CPackComponent.cmake, ...) in order to extract the corresponding doc.
* CPack begin the implementation of --help-command* and --help-variables*Eric NOULARD2012-01-221-49/+83
| | | | | | This modifications set tries to keep the unified doc for cmake/ctest/cpack while introducing tool specific documentation separated. Some documentation sections for CMake do not fit well to CPack.
* Usage: Document all options printing the version number.Nicolas Despres2011-10-231-1/+2
|
* Usage: Document all options printing usage information.Nicolas Despres2011-10-231-1/+1
|
* Remove trailing white-spaces.Nicolas Despres2011-10-231-76/+76
|
* -fix documentation from a module which has *only* documentationAlex Neundorf2010-05-081-12/+14
| | | | | | | | | This is #10466. It didn't crash for me, but also didn't work. The issue was that a line ending with something else than a # was considered as the end of the documentation block. If there was simply the end of the file we didn't get into the correct branch. Alex
* Fix for bug #0010466, fix crash in --help-module.Bill Hoffman2010-03-261-5/+12
|
* BUG 9961: ctest --help should not display a Generators sectionZach Mullen2009-11-241-1/+6
|
* Convert CMake to OSI-approved BSD LicenseBrad King2009-09-281-32/+25
| | | | | | | 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: Document CACHE entry propertiesBrad King2009-03-101-0/+1
| | | | | This adds a property documentation section for CACHE properties. We document the ADVANCED, HELPSTRING, TYPE, and VALUE properties.
* COMP: Fix assignment inside conditionBrad King2008-10-111-2/+2
|
* ENH: Improve generated documentation formattingBrad King2008-10-101-10/+113
| | | | | | | | | | | | 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.
* BUG: Fix help type for filenames with many dotsBrad King2008-10-101-1/+1
| | | | | The help page type should be determined using only the extension after the last dot. See issue #7797.
* BUG: fix 6647 arguments after -E should not be parsed by CMakeBill Hoffman2008-08-191-1/+6
|
* ENH: handle HTML documentation for single items better: no warning aboutAlexander Neundorf2008-07-211-1/+3
| | | | | | ComputeSectionLinkPrefix, don't create an index for only one item Alex
* 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-0/+46
|
* ENH: add support for creating the documentation in docbook formatAlexander Neundorf2008-02-191-1/+11
| | | | | | | | (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
* BUG: actually print the docs for custom modules if this was requestedAlexander Neundorf2008-02-171-1/+1
| | | | Alex
* BUG: make -help-module-list work by filling the modules section first, alsoAlexander Neundorf2008-01-141-0/+9
| | | | | | for custom modules Alex
* STYLE: Spelling fixes on documentationAmitha Perera2008-01-101-1/+1
|
* ENH: sort the module files alphabetically when generating the documentationAlexander Neundorf2008-01-091-5/+14
| | | | | | of rht modules Alex
* BUG: create modules documentation not only for the first documentation ↵Alexander Neundorf2007-12-291-0/+3
| | | | | | | | | | | creation step in cmake (the set ModulesFound wasn't cleared at the beginning of each PrintDocumentation() function, so when documentation for modules was executed the second time, ModulesFound already contained all modules and so no module was documented) Alex
* BUG: fix single module generationKen Martin2007-11-291-8/+14
|
* ENH: some more cleanup, fixes, and patch for HTML outputKen Martin2007-10-241-32/+147
|
* COMP: fix a problem with a shadowed varKen Martin2007-10-231-9/+6
|
* COMP: fix some warnings and add some doc strings back inKen Martin2007-10-221-0/+5
|
* COMP: fix some warnings and add some doc strings back inKen Martin2007-10-221-66/+79
|
* ENH: change to make the documentation class more generic, about halfway ↵Ken Martin2007-10-221-469/+268
| | | | there, also provides secitons for Variables now
* ENH: make commands lower case by defaultKen Martin2007-10-101-2/+2
|
* BUG: revert doc changes since VS7 cannot compile them, will implement them ↵Ken Martin2007-10-091-109/+106
| | | | in a different manner
* ENH: make documentation entries actually store their dataKen Martin2007-10-091-106/+109
|
* STYLE: fix line lengthsAlexander Neundorf2007-09-201-3/+5
| | | | Alex
* ENH: add new help option --help-custom-modules, which generatesAlexander Neundorf2007-09-191-22/+168
| | | | | | | | | | | 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
* STYLE: move the code for the different formats of the generated help intoAlexander Neundorf2007-09-191-561/+70
| | | | | | | their own classes, making cmDocumentation smaller and also making it easier to eventually add another format Alex
* BUG: properties and module names are case sensitiveAlexander Neundorf2007-08-091-27/+22
| | | | Alex
* STYLE: fix line lengthsAlexander Neundorf2007-07-201-9/+10
| | | | Alex
* STYLE: sort the property documentation intoAlexander Neundorf2007-07-111-18/+161
| | | | | | global/directory/target/test/sourcefile and variable sections Alex
* COMP: fix compile on HP-UX with aCC, reusing the same identifier for aAlexander Neundorf2007-07-031-38/+38
| | | | | | variable as for the enum type doesn't work here Alex
generated by cgit v0.12 at 2025-01-13 22:05:17 (GMT)