mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
4d8b33e5ba
Enclose the entire doc comment in /** */ to ensure that newlines don't cause comments to leak out and get parsed as C. rdar://problem/24923076
532 lines
8.5 KiB
Objective-C
532 lines
8.5 KiB
Objective-C
SWIFT_CLASS("_TtC8comments4A000")
|
|
@interface A000
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
/**
|
|
Aaa. A010. Bbb.
|
|
*/
|
|
SWIFT_CLASS("_TtC8comments21A010_AttachToEntities")
|
|
@interface A010_AttachToEntities
|
|
/**
|
|
Aaa. init().
|
|
*/
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
- (NSInteger)objectAtIndexedSubscript:(NSInteger)i;
|
|
- (void)setObject:(NSInteger)newValue atIndexedSubscript:(NSInteger)i;
|
|
/**
|
|
Aaa. v1.
|
|
*/
|
|
@property (nonatomic) NSInteger v1;
|
|
/**
|
|
Aaa. v2.
|
|
*/
|
|
@property (nonatomic, class, readonly) NSInteger v2;
|
|
@end
|
|
|
|
|
|
/**
|
|
Aaa. A013.
|
|
*/
|
|
SWIFT_PROTOCOL("_TtP8comments21A013_AttachToEntities_")
|
|
@protocol A013_AttachToEntities
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments10ATXHeaders")
|
|
@interface ATXHeaders
|
|
/**
|
|
<h1>LEVEL ONE</h1>
|
|
<h2>LEVEL TWO</h2>
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments13AutomaticLink")
|
|
@interface AutomaticLink
|
|
/**
|
|
And now for a URL.
|
|
<a href="http://developer.apple.com/swift/">http://developer.apple.com/swift/</a>
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments10BlockQuote")
|
|
@interface BlockQuote
|
|
/**
|
|
Aaa.
|
|
<blockquote>
|
|
Bbb.
|
|
|
|
</blockquote>
|
|
<blockquote>
|
|
Ccc.
|
|
|
|
</blockquote>
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments5Brief")
|
|
@interface Brief
|
|
/**
|
|
Aaa.
|
|
*/
|
|
- (void)f0;
|
|
/**
|
|
Aaa.
|
|
Bbb.
|
|
*/
|
|
- (void)f1;
|
|
/**
|
|
Aaa.
|
|
<blockquote>
|
|
Bbb.
|
|
|
|
</blockquote>
|
|
*/
|
|
- (void)f2;
|
|
/**
|
|
Aaa.
|
|
Bbb.
|
|
*/
|
|
- (void)f3;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments16ClosureContainer")
|
|
@interface ClosureContainer
|
|
/**
|
|
Partially applies a binary operator.
|
|
\param a The left-hand side to partially apply.
|
|
|
|
\param combine A binary operator.
|
|
|
|
\a combine parameters:
|
|
<ul>
|
|
<li>
|
|
lhs: The left-hand side of the operator
|
|
</li>
|
|
<li>
|
|
rhs: The right-hand side of the operator
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
\a combine returns: A result.
|
|
|
|
\a combine error: Nothing.
|
|
|
|
*/
|
|
- (void)closureParameterExplodedExplodedWithA:(NSInteger)a combine:(NSInteger (^ _Nonnull)(NSInteger lhs, NSInteger rhs))combine;
|
|
/**
|
|
Partially applies a binary operator.
|
|
\param a The left-hand side to partially apply.
|
|
|
|
\param combine A binary operator.
|
|
|
|
\a combine parameters:
|
|
<ul>
|
|
<li>
|
|
lhs: The left-hand side of the operator
|
|
</li>
|
|
<li>
|
|
rhs: The right-hand side of the operator
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
\a combine returns: A result.
|
|
|
|
\a combine error: Nothing.
|
|
|
|
*/
|
|
- (void)closureParameterOutlineExplodedWithA:(NSInteger)a combine:(NSInteger (^ _Nonnull)(NSInteger lhs, NSInteger rhs))combine;
|
|
/**
|
|
Partially applies a binary operator.
|
|
\param a The left-hand side to partially apply.
|
|
|
|
\param combine A binary operator.
|
|
|
|
\a combine parameters:
|
|
<ul>
|
|
<li>
|
|
lhs: The left-hand side of the operator
|
|
</li>
|
|
<li>
|
|
rhs: The right-hand side of the operator
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
\a combine returns: A result.
|
|
|
|
\a combine error: Nothing.
|
|
|
|
*/
|
|
- (void)closureParameterOutlineOutlineWithA:(NSInteger)a combine:(NSInteger (^ _Nonnull)(NSInteger lhs, NSInteger rhs))combine;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments9CodeBlock")
|
|
@interface CodeBlock
|
|
/**
|
|
This is how you use this code.
|
|
\code
|
|
f0() // WOW!
|
|
f0() // WOW!
|
|
f0() // WOW!
|
|
|
|
\endcode*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments8Emphasis")
|
|
@interface Emphasis
|
|
/**
|
|
Aaa <em>bbb</em> ccc.
|
|
Aaa <em>bbb</em> ccc.
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments13EmptyComments")
|
|
@interface EmptyComments
|
|
/**
|
|
*/
|
|
- (void)f0;
|
|
/**
|
|
Aaa.
|
|
*/
|
|
- (void)f1;
|
|
/**
|
|
*/
|
|
- (void)f2;
|
|
/**
|
|
*/
|
|
- (void)f3;
|
|
/**
|
|
Aaa.
|
|
*/
|
|
- (void)f4;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments19HasThrowingFunction")
|
|
@interface HasThrowingFunction
|
|
/**
|
|
Might throw something.
|
|
\param x A number
|
|
|
|
|
|
throws:
|
|
An error if \code
|
|
x == 0
|
|
\endcode
|
|
*/
|
|
- (void)f1:(NSInteger)x;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments15HorizontalRules")
|
|
@interface HorizontalRules
|
|
/**
|
|
Briefly.
|
|
<hr/>
|
|
The end.
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments16ImplicitNameLink")
|
|
@interface ImplicitNameLink
|
|
/**
|
|
<a href="https://www.apple.com/">Apple</a>
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments20IndentedBlockComment")
|
|
@interface IndentedBlockComment
|
|
/**
|
|
Brief.
|
|
First paragraph line.
|
|
Second paragraph line.
|
|
Now for a code sample:
|
|
\code
|
|
var x = 1
|
|
// var y = 2
|
|
var z = 3
|
|
|
|
\endcode*/
|
|
- (void)f1;
|
|
/**
|
|
Hugely indented brief.
|
|
First paragraph line.
|
|
Second paragraph line.
|
|
Now for a code sample:
|
|
\code
|
|
var x = 1
|
|
// var y = 2
|
|
var z = 3
|
|
|
|
\endcode*/
|
|
- (void)f2;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments10InlineCode")
|
|
@interface InlineCode
|
|
/**
|
|
Aaa \code
|
|
bbb
|
|
\endcode ccc.
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments10InlineLink")
|
|
@interface InlineLink
|
|
/**
|
|
Aaa <a href="/path/to/something">bbb</a> ccc.
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments14MultiLineBrief")
|
|
@interface MultiLineBrief
|
|
/**
|
|
Brief first line.
|
|
Brief after softbreak.
|
|
Some paragraph text.
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments11OrderedList")
|
|
@interface OrderedList
|
|
/**
|
|
<ol>
|
|
<li>
|
|
Aaa.
|
|
</li>
|
|
<li>
|
|
Bbb.
|
|
Ccc.
|
|
</li>
|
|
</ol>
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
/**
|
|
\param x A number
|
|
|
|
*/
|
|
SWIFT_CLASS("_TtC8comments15ParamAndReturns")
|
|
@interface ParamAndReturns
|
|
/**
|
|
Aaa. f0.
|
|
\param first Bbb.
|
|
|
|
\param second Ccc. Ddd.
|
|
Eee.
|
|
|
|
*/
|
|
- (void)f0:(NSInteger)first second:(double)second;
|
|
/**
|
|
Aaa. f1.
|
|
\param first Bbb.
|
|
|
|
|
|
returns:
|
|
Ccc.
|
|
Ddd.
|
|
*/
|
|
- (void)f1:(NSInteger)first;
|
|
/**
|
|
Aaa. f2.
|
|
\param first
|
|
|
|
\param second Aaa.
|
|
|
|
\param third
|
|
Bbb.
|
|
|
|
*/
|
|
- (void)f2:(NSInteger)first second:(double)second third:(float)third;
|
|
/**
|
|
Aaa. f3.
|
|
\param first Bbb.
|
|
|
|
\param second Ccc.
|
|
|
|
\param third Ddd.
|
|
|
|
*/
|
|
- (void)f3:(NSInteger)first second:(double)second third:(float)third;
|
|
/**
|
|
Aaa. f4.
|
|
|
|
returns:
|
|
Eee.
|
|
Fff.
|
|
*/
|
|
- (void)f4;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments16ParameterOutline")
|
|
@interface ParameterOutline
|
|
/**
|
|
\param x A number
|
|
|
|
\param y A number
|
|
|
|
\param z A number
|
|
|
|
*/
|
|
- (void)f0:(NSInteger)x y:(NSInteger)y z:(NSInteger)z;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments22ParameterOutlineMiddle")
|
|
@interface ParameterOutlineMiddle
|
|
/**
|
|
<ul>
|
|
<li>
|
|
This line should remain.
|
|
</li>
|
|
<li>
|
|
This line should also remain.
|
|
</li>
|
|
</ul>
|
|
\param x A number
|
|
|
|
\param y A number
|
|
|
|
\param z A number
|
|
|
|
*/
|
|
- (void)f0:(NSInteger)x y:(NSInteger)y z:(NSInteger)z;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments13ReferenceLink")
|
|
@interface ReferenceLink
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments7Returns")
|
|
@interface Returns
|
|
/**
|
|
|
|
returns:
|
|
A number
|
|
*/
|
|
- (NSInteger)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments18SeparateParameters")
|
|
@interface SeparateParameters
|
|
/**
|
|
\param x A number
|
|
|
|
*/
|
|
- (void)f0:(NSInteger)x y:(NSInteger)y;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments13SetextHeaders")
|
|
@interface SetextHeaders
|
|
/**
|
|
<h1>LEVEL ONE</h1>
|
|
<h2>LEVEL TWO</h2>
|
|
<h3>LEVEL THREE</h3>
|
|
<h4>LEVEL FOUR</h4>
|
|
<h5>LEVEL FIVE</h5>
|
|
<h5>LEVEL SIX</h5>
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments14StrongEmphasis")
|
|
@interface StrongEmphasis
|
|
/**
|
|
Aaa <em>bbb</em> ccc.
|
|
Aaa <em>bbb</em> ccc.
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
|
|
SWIFT_CLASS("_TtC8comments13UnorderedList")
|
|
@interface UnorderedList
|
|
/**
|
|
<ul>
|
|
<li>
|
|
Aaa.
|
|
</li>
|
|
<li>
|
|
Bbb.
|
|
Ccc.
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li>
|
|
Ddd.
|
|
</li>
|
|
<li>
|
|
Eee.
|
|
<ul>
|
|
<li>
|
|
Fff.
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
*/
|
|
- (void)f0;
|
|
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
|
|
@end
|
|
|
|
#pragma clang diagnostic pop
|