is inheritdoc available in swift?


(Maciej Madaj) #1

Hi!

I’m developing SDK for iOS, written purely in Swift - and I wonder is there
a way to use something similar to inheritdoc like in Java? Possible use
case: documentation stored in protocol which later on will be accessible in
objects confronting protocol:

protocol test {
/**
It does the magic! Loren ipsum, long description. Whatever
*/
func magic() -> Int
}

class TestClass: test {

/**
@inherticdoc? instead of pasting protocol documentation
*/
public fund magic() -> Int {
return 21
}

}

so when calling

let x = TestClass()
x.magic()

in quick help I would see „It does the magic! (…)” - without tedious
copy&paste and managing in many places.

Default behavior looks to omit it all along.

Best regards.


(Dmitri Gribenko) #2

Hi Maciej,

This is a feature that we likely want on by default without any
annotations. It does not exist yet, and it is tracked by
https://bugs.swift.org/browse/SR-539

Dmitri

···

On Mon, Mar 21, 2016 at 11:02 AM, Maciej Madaj via swift-users <swift-users@swift.org> wrote:

Hi!

I’m developing SDK for iOS, written purely in Swift - and I wonder is there
a way to use something similar to inheritdoc like in Java?

--
main(i,j){for(i=2;;i++){for(j=2;j<i;j++){if(!(i%j)){j=0;break;}}if
(j){printf("%d\n",i);}}} /*Dmitri Gribenko <gribozavr@gmail.com>*/