Merge pull request #6443 from practicalswift/argument-names

practicalswift · web-flow · commit d88c188d4707 · 2016-12-21T23:25:29.000+01:00
[gardening] Make sure argument names in comments match the actual parameter names
diff --git a/lib/AST/ASTContext.cpp b/lib/AST/ASTContext.cpp
@@ -1213,8 +1213,8 @@ ClangModuleLoader *ASTContext::getClangModuleLoader() const {
 static void recordKnownProtocol(Module *Stdlib, StringRef Name,
                                 KnownProtocolKind Kind) {
   Identifier ID = Stdlib->getASTContext().getIdentifier(Name);
-  UnqualifiedLookup Lookup(ID, Stdlib, nullptr, /*NonCascading=*/true,
-                           SourceLoc(), /*IsType=*/true);
+  UnqualifiedLookup Lookup(ID, Stdlib, nullptr, /*IsKnownPrivate=*/true,
+                           SourceLoc(), /*IsTypeLookup=*/true);
   if (auto Proto
         = dyn_cast_or_null<ProtocolDecl>(Lookup.getSingleTypeResult()))
     Proto->setKnownProtocolKind(Kind);
diff --git a/lib/AST/DeclContext.cpp b/lib/AST/DeclContext.cpp
@@ -917,7 +917,7 @@ void IterableDeclContext::loadAllMembers() const {
   // Don't try to load all members re-entrant-ly.
   ASTContext &ctx = getASTContext();
   auto contextInfo = ctx.getOrCreateLazyIterableContextData(this,
-                                                            /*loader=*/nullptr);
+    /*lazyLoader=*/nullptr);
   FirstDeclAndLazyMembers.setInt(false);
 
   const Decl *container = nullptr;
diff --git a/lib/AST/DocComment.cpp b/lib/AST/DocComment.cpp
@@ -404,7 +404,7 @@ getProtocolRequirementDocComment(swift::markup::MarkupContext &MC,
       SmallVector<ValueDecl *, 2> Members;
       P->lookupQualified(P->getDeclaredType(), VD->getFullName(),
                          NLOptions::NL_ProtocolMembers,
-                         /*resolver=*/nullptr, Members);
+                         /*typeResolver=*/nullptr, Members);
     SmallVector<const ValueDecl *, 1> ProtocolRequirements;
     for (auto Member : Members)
       if (!Member->isDefinition())
diff --git a/lib/AST/NameLookup.cpp b/lib/AST/NameLookup.cpp
@@ -462,9 +462,10 @@ UnqualifiedLookup::UnqualifiedLookup(DeclName Name, DeclContext *DC,
     if (Name.isOperator()) {
       if (!isCascadingUse.hasValue()) {
         DeclContext *innermostDC =
-            lookupScope->getInnermostEnclosingDeclContext();
+          lookupScope->getInnermostEnclosingDeclContext();
         isCascadingUse =
-          innermostDC->isCascadingContextForLookup(/*excludeFunctions=*/true);
+          innermostDC->isCascadingContextForLookup(
+            /*functionsAreNonCascading=*/true);
       }
 
       lookupScope = &sourceFile.getScope();
@@ -502,7 +503,7 @@ UnqualifiedLookup::UnqualifiedLookup(DeclName Name, DeclContext *DC,
         // If we haven't determined whether we have a cascading use, do so now.
         if (!isCascadingUse.hasValue()) {
           isCascadingUse =
-            dc->isCascadingContextForLookup(/*excludeFunctions=*/false);
+            dc->isCascadingContextForLookup(/*functionsAreNonCascading=*/false);
         }
 
         // Pattern binding initializers are only interesting insofar as they
@@ -662,7 +663,7 @@ UnqualifiedLookup::UnqualifiedLookup(DeclName Name, DeclContext *DC,
     if (Name.isOperator()) {
       if (!isCascadingUse.hasValue()) {
         isCascadingUse =
-          DC->isCascadingContextForLookup(/*excludeFunctions=*/true);
+          DC->isCascadingContextForLookup(/*functionsAreNonCascading=*/true);
       }
       DC = DC->getModuleScopeContext();
 
@@ -1342,7 +1343,7 @@ bool DeclContext::lookupQualified(Type type,
   auto checkLookupCascading = [this, options]() -> Optional<bool> {
     switch (static_cast<unsigned>(options & NL_KnownDependencyMask)) {
     case 0:
-      return isCascadingContextForLookup(/*excludeFunctions=*/false);
+      return isCascadingContextForLookup(/*functionsAreNonCascading=*/false);
     case NL_KnownNonCascadingDependency:
       return false;
     case NL_KnownCascadingDependency:
diff --git a/lib/AST/Type.cpp b/lib/AST/Type.cpp
@@ -710,7 +710,7 @@ static Type getStrippedType(const ASTContext &context, Type type,
 }
 
 Type TypeBase::getUnlabeledType(ASTContext &Context) {
-  return getStrippedType(Context, Type(this), /*labels=*/true);
+  return getStrippedType(Context, Type(this), /*stripLabels=*/true);
 }
 
 Type TypeBase::getWithoutParens() {
diff --git a/lib/ClangImporter/ClangDiagnosticConsumer.cpp b/lib/ClangImporter/ClangDiagnosticConsumer.cpp
@@ -112,7 +112,7 @@ SourceLoc ClangDiagnosticConsumer::resolveSourceLocation(
     std::unique_ptr<llvm::MemoryBuffer> mirrorBuffer{
       llvm::MemoryBuffer::getMemBuffer(buffer->getBuffer(),
                                        buffer->getBufferIdentifier(),
-                                       /*nullTerminated=*/true)
+                                       /*RequiresNullTerminator=*/true)
     };
     mirrorID = swiftSrcMgr.addNewSourceBuffer(std::move(mirrorBuffer));
     mirroredBuffers[buffer] = mirrorID;
diff --git a/lib/ClangImporter/ClangImporter.cpp b/lib/ClangImporter/ClangImporter.cpp
@@ -83,7 +83,7 @@ namespace {
       if (!imported)
         return;
       Module *nativeImported = Impl.finishLoadingClangModule(Importer, imported,
-                                                             /*adapter=*/true);
+        /*preferAdapter=*/true);
       Impl.ImportedHeaderExports.push_back({ /*filter=*/{}, nativeImported });
     }
 
@@ -846,7 +846,7 @@ bool ClangImporter::Implementation::importHeader(
       static_cast<HeaderParsingASTConsumer &>(Instance->getASTConsumer());
   consumer.reset();
 
-  pp.EnterSourceFile(bufferID, /*directoryLookup=*/nullptr, /*Loc=*/{});
+  pp.EnterSourceFile(bufferID, /*Dir=*/nullptr, /*Loc=*/{});
   // Force the import to occur.
   pp.LookAhead(0);
 
@@ -909,7 +909,7 @@ bool ClangImporter::importHeader(StringRef header, Module *adapter,
                                  StringRef cachedContents, SourceLoc diagLoc) {
   clang::FileManager &fileManager = Impl.Instance->getFileManager();
   const clang::FileEntry *headerFile = fileManager.getFile(header,
-                                                           /*open=*/true);
+                                                           /*OpenFile=*/true);
   if (headerFile && headerFile->getSize() == expectedSize &&
       headerFile->getModificationTime() == expectedModTime) {
     return importBridgingHeader(header, adapter, diagLoc);
@@ -929,7 +929,7 @@ bool ClangImporter::importBridgingHeader(StringRef header, Module *adapter,
                                          bool trackParsedSymbols) {
   clang::FileManager &fileManager = Impl.Instance->getFileManager();
   const clang::FileEntry *headerFile = fileManager.getFile(header,
-                                                           /*open=*/true);
+                                                           /*OpenFile=*/true);
   if (!headerFile) {
     Impl.SwiftContext.Diags.diagnose(diagLoc, diag::bridging_header_missing,
                                      header);
@@ -1090,7 +1090,8 @@ Module *ClangImporter::loadModule(
   if (!clangModule)
     return nullptr;
 
-  return Impl.finishLoadingClangModule(*this, clangModule, /*adapter=*/false);
+  return Impl.finishLoadingClangModule(*this, clangModule,
+                                       /*preferAdapter=*/false);
 }
 
 Module *ClangImporter::Implementation::finishLoadingClangModule(
@@ -2168,11 +2169,11 @@ void ClangModuleUnit::lookupObjCMethods(
   auto &clangSema = owner.Impl.getClangSema();
   clangSema.CollectMultipleMethodsInGlobalPool(clangSelector,
                                                objcMethods,
-                                               /*instance=*/true,
+                                               /*InstanceFirst=*/true,
                                                /*CheckTheOther=*/false);
   clangSema.CollectMultipleMethodsInGlobalPool(clangSelector,
                                                objcMethods,
-                                               /*instance=*/false,
+                                               /*InstanceFirst=*/false,
                                                /*CheckTheOther=*/false);
 
   // Import the methods.
diff --git a/lib/ClangImporter/ImportDecl.cpp b/lib/ClangImporter/ImportDecl.cpp
@@ -3114,7 +3114,7 @@ namespace {
     /// The importer should use this rather than adding the attribute directly.
     void addObjCAttribute(ValueDecl *decl, Optional<ObjCSelector> name) {
       auto &ctx = Impl.SwiftContext;
-      decl->getAttrs().add(ObjCAttr::create(ctx, name, /*implicit=*/true));
+      decl->getAttrs().add(ObjCAttr::create(ctx, name, /*implicitName=*/true));
 
       // If the declaration we attached the 'objc' attribute to is within a
       // class, record it in the class.
diff --git a/lib/FrontendTool/FrontendTool.cpp b/lib/FrontendTool/FrontendTool.cpp
@@ -153,11 +153,11 @@ static bool printAsObjC(const std::string &outputPath, Module *M,
     Clang.createOutputFile(outputPath, EC,
                            /*Binary=*/false,
                            /*RemoveFileOnSignal=*/true,
-                           /*inputPath=*/"",
+                           /*BaseInput=*/"",
                            path::extension(outputPath),
                            /*UseTemporary=*/true,
-                           /*createDirs=*/false,
-                           /*finalPath=*/nullptr,
+                           /*CreateMissingDirectories=*/false,
+                           /*ResultPathName=*/nullptr,
                            &tmpFilePath);
 
   if (!out) {
diff --git a/lib/FrontendTool/ReferenceDependencies.cpp b/lib/FrontendTool/ReferenceDependencies.cpp
@@ -99,11 +99,12 @@ static bool extendedTypeIsPrivate(TypeLoc inheritedType) {
 }
 
 static std::string mangleTypeAsContext(const NominalTypeDecl *type) {
-  Mangle::Mangler mangler(/*debug style=*/false, /*Unicode=*/true);
+  Mangle::Mangler mangler(/*debug style=*/false, /*usePunycode=*/true);
   mangler.mangleContext(type);
   std::string Old = mangler.finalize();
 
-  NewMangling::ASTMangler NewMangler(/*debug style=*/false, /*Unicode=*/true);
+  NewMangling::ASTMangler NewMangler(/*debug style=*/false,
+                                     /*usePunycode=*/true);
   std::string New = NewMangler.mangleTypeAsContextUSR(type);
 
   return NewMangling::selectMangling(Old, New);
diff --git a/lib/IRGen/GenClass.cpp b/lib/IRGen/GenClass.cpp
@@ -2035,7 +2035,7 @@ ClassDecl *IRGenModule::getObjCRuntimeBaseClass(Identifier name,
   SwiftRootClass->computeType();
   SwiftRootClass->setIsObjC(true);
   SwiftRootClass->getAttrs().add(ObjCAttr::createNullary(Context, objcName,
-                                                         /*implicit=*/true));
+    /*isNameImplicit=*/true));
   SwiftRootClass->setImplicit();
   SwiftRootClass->setAccessibility(Accessibility::Open);
   
diff --git a/lib/Parse/ParseExpr.cpp b/lib/Parse/ParseExpr.cpp
@@ -1505,7 +1505,7 @@ ParserResult<Expr> Parser::parseExprPostfix(Diag<> ID, bool isExprBasic) {
       }
 
       DeclNameLoc NameLoc;
-      DeclName Name = parseUnqualifiedDeclName(/*allowDot=*/true,
+      DeclName Name = parseUnqualifiedDeclName(/*afterDot=*/true,
                                                NameLoc,
                                                diag::expected_member_name);
       if (!Name) return nullptr;
diff --git a/lib/SIL/SILFunctionType.cpp b/lib/SIL/SILFunctionType.cpp
@@ -106,7 +106,7 @@ static CanType getKnownType(Optional<CanType> &cacheSlot, ASTContext &C,
       SmallVector<ValueDecl *, 2> decls;
       mod->lookupQualified(ModuleType::get(mod), C.getIdentifier(typeName),
                            NL_QualifiedDefault | NL_KnownNonCascadingDependency,
-                           /*resolver=*/nullptr, decls);
+                           /*typeResolver=*/nullptr, decls);
       if (decls.size() != 1)
         return CanType();
 
diff --git a/lib/Sema/CSApply.cpp b/lib/Sema/CSApply.cpp
@@ -1719,7 +1719,7 @@ namespace {
       
       if (!MaxIntegerTypeDecl) {
         SmallVector<ValueDecl *, 1> lookupResults;
-        tc.getStdlibModule(dc)->lookupValue(/*filter=*/{},
+        tc.getStdlibModule(dc)->lookupValue(/*AccessPath=*/{},
                                             tc.Context.Id_MaxBuiltinIntegerType,
                                             NLKind::QualifiedLookup,
                                             lookupResults);
@@ -1814,7 +1814,7 @@ namespace {
       // FIXME: Cache name lookup.
       if (!MaxFloatTypeDecl) {
         SmallVector<ValueDecl *, 1> lookupResults;
-        tc.getStdlibModule(dc)->lookupValue(/*filter=*/{},
+        tc.getStdlibModule(dc)->lookupValue(/*AccessPath=*/{},
                                             tc.Context.Id_MaxBuiltinFloatType,
                                             NLKind::QualifiedLookup,
                                             lookupResults);
diff --git a/lib/Sema/CodeSynthesis.cpp b/lib/Sema/CodeSynthesis.cpp
@@ -565,7 +565,7 @@ static ProtocolDecl *getNSCopyingProtocol(TypeChecker &TC,
   DC->lookupQualified(ModuleType::get(foundation),
                       ctx.getSwiftId(KnownFoundationEntity::NSCopying),
                       NL_QualifiedDefault | NL_KnownNonCascadingDependency,
-                      /*resolver=*/nullptr,
+                      /*typeResolver=*/nullptr,
                       results);
 
   if (results.size() != 1)
diff --git a/lib/Sema/ConstraintSystem.cpp b/lib/Sema/ConstraintSystem.cpp
@@ -721,7 +721,7 @@ ConstraintSystem::getTypeOfReference(ValueDecl *value,
 
     auto openedType = openFunctionType(
             func->getInterfaceType()->castTo<AnyFunctionType>(),
-            /*numRemovedArgumentLabels=*/0,
+            /*numArgumentLabelsToRemove=*/0,
             locator, replacements,
             func->getInnermostDeclContext(),
             func->getDeclContext(),
diff --git a/lib/Sema/TypeCheckDecl.cpp b/lib/Sema/TypeCheckDecl.cpp
@@ -2488,7 +2488,7 @@ static void inferObjCName(TypeChecker &tc, ValueDecl *decl) {
   if (requirementObjCName) {
     if (attr)
       const_cast<ObjCAttr *>(attr)->setName(*requirementObjCName,
-                                            /*implicit=*/true);
+                                            /*implicitName=*/true);
     else
       decl->getAttrs().add(
         ObjCAttr::create(tc.Context, *requirementObjCName,
diff --git a/lib/Serialization/Serialization.cpp b/lib/Serialization/Serialization.cpp
@@ -4063,7 +4063,7 @@ static void addOperatorsAndTopLevel(Serializer &S, Range members,
       if (isDerivedTopLevel) {
         topLevelDecls[memberValue->getName()].push_back({
           /*ignored*/0,
-          S.addDeclRef(memberValue, /*force=*/true)
+          S.addDeclRef(memberValue, /*forceSerialization=*/true)
         });
       } else if (memberValue->isOperator()) {
         // Add operator methods.
@@ -4296,11 +4296,11 @@ withOutputFile(ASTContext &ctx, StringRef outputPath,
       Clang.createOutputFile(outputPath, EC,
                              /*Binary=*/true,
                              /*RemoveFileOnSignal=*/true,
-                             /*inputPath=*/"",
+                             /*BaseInput=*/"",
                              path::extension(outputPath),
                              /*UseTemporary=*/true,
-                             /*createDirs=*/false,
-                             /*finalPath=*/nullptr,
+                             /*CreateMissingDirectories=*/false,
+                             /*ResultPathName=*/nullptr,
                              &tmpFilePath);
 
     if (!out) {
diff --git a/stdlib/public/Reflection/TypeLowering.cpp b/stdlib/public/Reflection/TypeLowering.cpp
@@ -890,7 +890,7 @@ class EnumTypeInfoBuilder {
     // NoPayloadEnumImplStrategy
     if (PayloadCases.empty()) {
       Kind = RecordKind::NoPayloadEnum;
-      Size += getNumTagBytes(/*payloadSize=*/0,
+      Size += getNumTagBytes(/*size=*/0,
                              NoPayloadCases,
                              /*payloadCases=*/0);
 
diff --git a/stdlib/public/runtime/ProtocolConformance.cpp b/stdlib/public/runtime/ProtocolConformance.cpp
@@ -514,7 +514,7 @@ swift::swift_conformsToProtocol(const Metadata * const type,
         if (protocol != P)
           continue;
 
-        if (!isRelatedType(type, metadata, /*isMetadata=*/true))
+        if (!isRelatedType(type, metadata, /*candidateIsMetadata=*/true))
           continue;
 
         // Store the type-protocol pair in the cache.
@@ -538,7 +538,7 @@ swift::swift_conformsToProtocol(const Metadata * const type,
         if (protocol != P)
           continue;
 
-        if (!isRelatedType(type, R, /*isMetadata=*/false))
+        if (!isRelatedType(type, R, /*candidateIsMetadata=*/false))
           continue;
 
         // Store the type-protocol pair in the cache.

Original file line number	Diff line number	Diff line change
`@@ -710,7 +710,7 @@ static Type getStrippedType(const ASTContext &context, Type type,`
`710`	`710`	`}`
`711`	`711`
`712`	`712`	`Type TypeBase::getUnlabeledType(ASTContext &Context) {`
`713`		`- return getStrippedType(Context, Type(this), /labels=/true);`
	`713`	`+ return getStrippedType(Context, Type(this), /stripLabels=/true);`
`714`	`714`	`}`
`715`	`715`
`716`	`716`	`Type TypeBase::getWithoutParens() {`