summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentation.h
diff options
context:
space:
mode:
authorEric NOULARD <eric.noulard@gmail.com>2012-01-02 23:54:08 (GMT)
committerEric NOULARD <eric.noulard@gmail.com>2012-01-22 12:31:24 (GMT)
commit1629615a10df10296ba6588f66a680eed424f9ba (patch)
tree4a59c67918578b94dbced9f0fde63f7af3005af2 /Source/cmDocumentation.h
parent83e34dd9e688b4721c70c56e66629bdc2768fa77 (diff)
downloadCMake-1629615a10df10296ba6588f66a680eed424f9ba.zip
CMake-1629615a10df10296ba6588f66a680eed424f9ba.tar.gz
CMake-1629615a10df10296ba6588f66a680eed424f9ba.tar.bz2
CPack Documentation extraction from CMake script begins to work
- 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
Diffstat (limited to 'Source/cmDocumentation.h')
-rw-r--r--Source/cmDocumentation.h11
1 files changed, 7 insertions, 4 deletions
diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h
index 2f6e09e..fae409f 100644
--- a/Source/cmDocumentation.h
+++ b/Source/cmDocumentation.h
@@ -133,23 +133,26 @@ public:
void addCPackStandardDocSections();
/**
- * Get the documentation of macros and variable documented
+ * Get the documentation of macros, functions and variable documented
* with CMake structured documentation in a CMake script.
+ * (in fact it may be in any file which follow the structured doc format)
* Structured documentation begin with
* ## (double sharp) in column 1 & 2 immediately followed
* by a markup. Those ## are ignored by the legacy module
* documentation parser @see CreateSingleModule.
- * Current markup are ##macro, ##param, ##variable and ##end
- * which is closing either of the previous ones.
+ * Current markup are ##macro, ##function, ##variable and ##end.
+ * ##end is closing either of the previous ones.
* @param[in] fname the script file name to be parsed for documentation
* @param[in,out] commands the vector of command/macros documentation
* entry found in the script file.
* @param[in,out] the cmake object instance to which variable documentation
* will be attached (using @see cmake::DefineProperty)
+ * @param[in] the documentation section in which the property will be
+ * inserted.
* @return the number of documented items (command and variable)
* found in the file.
*/
- int getStructuredDocFromFile(const char* fname,
+ int GetStructuredDocFromFile(const char* fname,
std::vector<cmDocumentationEntry>& commands,
cmake* cm,
const char *docSection);