Author: Jan Svoboda Date: 2021-04-15T10:31:09+02:00 New Revision: 06eff02ba18b02bff3a8d5759cc4a5ee043e4112
URL: https://github.com/llvm/llvm-project/commit/06eff02ba18b02bff3a8d5759cc4a5ee043e4112 DIFF: https://github.com/llvm/llvm-project/commit/06eff02ba18b02bff3a8d5759cc4a5ee043e4112.diff LOG: [clang][deps] NFC: Improve documentation Fix typos and simplify wording Added: Modified: clang/include/clang/Tooling/DependencyScanning/DependencyScanningTool.h Removed: ################################################################################ diff --git a/clang/include/clang/Tooling/DependencyScanning/DependencyScanningTool.h b/clang/include/clang/Tooling/DependencyScanning/DependencyScanningTool.h index b4fa27f531e32..09c385783c52c 100644 --- a/clang/include/clang/Tooling/DependencyScanning/DependencyScanningTool.h +++ b/clang/include/clang/Tooling/DependencyScanning/DependencyScanningTool.h @@ -45,14 +45,14 @@ struct FullDependencies { /// appending to the original command line to pass to clang. std::vector<std::string> AdditionalNonPathCommandLine; - /// Gets the full addtional command line suitable for appending to the - /// original command line to pass to clang. + /// Get additional arguments suitable for appending to the original Clang + /// command line. /// - /// \param LookupPCMPath this function is called to fill in `-fmodule-file=` + /// \param LookupPCMPath This function is called to fill in `-fmodule-file=` /// flags and for the `-o` flag. It needs to return a /// path for where the PCM for the given module is to /// be located. - /// \param LookupModuleDeps this fucntion is called to collect the full + /// \param LookupModuleDeps This function is called to collect the full /// transitive set of dependencies for this /// compilation. std::vector<std::string> getAdditionalCommandLine( @@ -82,15 +82,14 @@ class DependencyScanningTool { getDependencyFile(const tooling::CompilationDatabase &Compilations, StringRef CWD); - /// Collect the full module depenedency graph for the input, ignoring any + /// Collect the full module dependency graph for the input, ignoring any /// modules which have already been seen. /// - /// \param AlreadySeen this is used to not report modules that have previously - /// been reported. Use the same `llvm::StringSet<>` for all - /// calls to `getFullDependencies` for a single - /// `DependencyScanningTool` for a single build. Use a - /// diff erent one for diff erent tools, and clear it between - /// builds. + /// \param AlreadySeen This stores modules which have previously been + /// reported. Use the same instance for all calls to this + /// function for a single \c DependencyScanningTool in a + /// single build. Use a diff erent one for diff erent tools, + /// and clear it between builds. /// /// \returns a \c StringError with the diagnostic output if clang errors /// occurred, \c FullDependencies otherwise. _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
