search

apple / swift-system

Low-level system calls and types for Swift
Apache License 2.0
1.18k stars 102 forks source link

Fix doc comment placement #119

Closed amartini51 closed 1 year ago

amartini51 commented 1 year ago

If there's anything between the /// doc comment and the declaration, DocC fails to associate them. This results in the symbol having no documentation.

amartini51 commented 1 year ago

@swift-ci Please test.

lorentey commented 1 year ago

Shame about having to move the availability annotation so far away from the function signature. Oh well. 😞

lorentey commented 1 year ago

@swift-ci test and merge

amartini51 commented 1 year ago

Shame about having to move the availability annotation so far away from the function signature. Oh well. 😞

@lorentey Do you mean this one? https://github.com/apple/swift-system/pull/119/files#diff-c2002aff6395f9cafc86d990b575e74bf7ad4c3a048e0bd9f6af906ff18ef98fL43

For non-commented-out @available lines, those are part of the declaration, so they wouldn't need to move.