diff options
author | Brad King <brad.king@kitware.com> | 2013-09-27 14:58:30 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-15 14:47:39 (GMT) |
commit | 0d0fec152443fa3f63af8e68e3b2784b6523d85d (patch) | |
tree | e5aa74fc081cb21d21fa4ffc39be281425ecbef2 /Source/cmDocumentation.h | |
parent | 946f0efb7cc15476b54dc57ca5daa785f3f9a937 (diff) | |
download | CMake-0d0fec152443fa3f63af8e68e3b2784b6523d85d.zip CMake-0d0fec152443fa3f63af8e68e3b2784b6523d85d.tar.gz CMake-0d0fec152443fa3f63af8e68e3b2784b6523d85d.tar.bz2 |
Drop CPack module documentation markup extraction
This will be replaced by alternative markup later.
Diffstat (limited to 'Source/cmDocumentation.h')
-rw-r--r-- | Source/cmDocumentation.h | 38 |
1 files changed, 0 insertions, 38 deletions
diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h index 218f44d..68ddbb8 100644 --- a/Source/cmDocumentation.h +++ b/Source/cmDocumentation.h @@ -151,44 +151,6 @@ public: /** Add automatic variables sections */ void addAutomaticVariableSections(const std::string& section); - /** - * Retrieve the list of documented module located in - * path which match the globing expression globExpr. - * @param[in] path directory where to start the search - * we will recurse into it. - * @param[in] globExpr the globing expression used to - * match the file in path. - * @param[out] docModuleList the list of obtained pairs (may be empty) - * @return 0 on success 1 on error or empty list - */ - int getDocumentedModulesListInDir( - std::string path, - std::string globExpr, - documentedModulesList_t& docModuleList); - - /** - * 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 ##section, ##module, - * ##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] cm the cmake object instance to which variable - * documentation will be attached - * (using @see cmake::DefineProperty) - * @return the number of documented items (command and variable) - * found in the file. - */ - int GetStructuredDocFromFile(const char* fname, - std::vector<cmDocumentationEntry>& commands, - cmake* cm); private: void SetForm(Form f, int manSection); void SetDocName(const char* docname); |