Skip to content

[gardening] Use proper doxygen comments (///) #5960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 29, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion include/swift/SIL/SILCloner.h
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ SILCloner<ImplClass>::postProcess(SILInstruction *Orig,
InstructionMap.insert(std::make_pair(Orig, Cloned));
}

// \brief Recursively visit a callee's BBs in depth-first preorder (only
/// \brief Recursively visit a callee's BBs in depth-first preorder (only
/// processing blocks on the first visit), mapping newly visited BBs to new BBs
/// in the caller and cloning all instructions into the caller other than
/// terminators which should be handled separately later by subclasses
Expand Down
20 changes: 10 additions & 10 deletions lib/SILOptimizer/LoopTransforms/COWArrayOpt.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -359,14 +359,14 @@ class COWArrayOpt {
// make_mutable calls are required within the loop body for that array.
llvm::SmallDenseMap<SILValue, ApplyInst*> ArrayMakeMutableMap;

// \brief Transient per-Array user set.
//
// Track all known array users with the exception of struct_extract users
// (checkSafeArrayElementUse prohibits struct_extract users from mutating the
// array). During analysis of retains/releases within the loop body, the
// users in this set are assumed to cover all possible mutating operations on
// the array. If the array escaped through an unknown use, the analysis must
// abort earlier.
/// \brief Transient per-Array user set.
///
/// Track all known array users with the exception of struct_extract users
/// (checkSafeArrayElementUse prohibits struct_extract users from mutating the
/// array). During analysis of retains/releases within the loop body, the
/// users in this set are assumed to cover all possible mutating operations on
/// the array. If the array escaped through an unknown use, the analysis must
/// abort earlier.
SmallPtrSet<SILInstruction*, 8> ArrayUserSet;

// When matching retains to releases we must not match the same release twice.
Expand Down Expand Up @@ -466,8 +466,8 @@ SmallPtrSetImpl<SILBasicBlock*> &COWArrayOpt::getReachingBlocks() {
}


// \return true if the instruction is a call to a non-mutating array semantic
// function.
/// \return true if the instruction is a call to a non-mutating array semantic
/// function.
static bool isNonMutatingArraySemanticCall(SILInstruction *Inst) {
ArraySemanticsCall Call(Inst);
if (!Call)
Expand Down
6 changes: 3 additions & 3 deletions lib/Sema/ConstraintSystem.h
Original file line number Diff line number Diff line change
Expand Up @@ -1553,9 +1553,9 @@ class ConstraintSystem {
void assignFixedType(TypeVariableType *typeVar, Type type,
bool updateState = true);

// \brief Set the TVO_MustBeMaterializable bit on all type variables
// necessary to ensure that the type in question is materializable in a
// viable solution.
/// \brief Set the TVO_MustBeMaterializable bit on all type variables
/// necessary to ensure that the type in question is materializable in a
/// viable solution.
void setMustBeMaterializableRecursive(Type type);

/// \brief Determine if the type in question is an Array<T>.
Expand Down