averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-14 20:36:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

Remove \brief commands from doxygen comments.

Browse Source 
We've been running doxygen with the autobrief option for a couple of
years now. This makes the \brief markers into our comments
redundant. Since they are a visual distraction and we don't want to
encourage more \brief markers in new code either, this patch removes
them all.

Patch produced by

      for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done
This commit is contained in:
Adrian Prantl
2018-12-04 13:49:39 -08:00
parent b3ca05708d
commit ff63eaea6f
287 changed files with 2051 additions and 2051 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/swift/SwiftDemangle/SwiftDemangle.h
View File

@@ -37,7 +37,7 @@
extern "C" {
#endif
/// \brief Demangle Swift function names.
/// Demangle Swift function names.
///
/// \returns the length of the demangled function name (even if greater than the
/// size of the output buffer) or 0 if the input is not a Swift-mangled function
@@ -46,7 +46,7 @@ SWIFT_DEMANGLE_LINKAGE
size_t swift_demangle_getDemangledName(const char *MangledName,
char *OutputBuffer, size_t Length);
/// \brief Demangle Swift function names with module names and implicit self
/// Demangle Swift function names with module names and implicit self
/// and metatype type names in function signatures stripped.
///
/// \returns the length of the demangled function name (even if greater than the
@@ -57,7 +57,7 @@ size_t swift_demangle_getSimplifiedDemangledName(const char *MangledName,
char *OutputBuffer,
size_t Length);
/// \brief Demangles a Swift function name and returns true if the function
/// Demangles a Swift function name and returns true if the function
/// conforms to the Swift calling convention.
///
/// \returns true if the function conforms to the Swift calling convention.
@@ -88,7 +88,7 @@ int swift_demangle_hasSwiftCallingConvention(const char *MangledName);
extern "C" {
#endif
/// \brief Demangle Swift function names.
/// Demangle Swift function names.
///
/// Note that this function has a generic name because it is called from
/// contexts where it is not appropriate to use code names.