Skip to content
This repository has been archived by the owner on Jun 1, 2023. It is now read-only.

SwiftDoc only generates documentation for some non-public members #136

Closed
a2 opened this issue Jul 2, 2020 · 2 comments
Closed

SwiftDoc only generates documentation for some non-public members #136

a2 opened this issue Jul 2, 2020 · 2 comments
Labels
bug Something isn't working
Milestone

Comments

@a2
Copy link

a2 commented Jul 2, 2020

It seems that SwiftDoc only generates documentation for public types but I have noticed that some non-public members are sometimes still generated:

  1. internal nested type has an entry on the public parent type's page but the destination is a 404
  2. internal properties on public types
  3. internal initializers on public types
public struct MyStruct: Encodable {
    enum CodingKeys: String, CodingKey { // [1]
        case value = "Value"
    } 

    let value: String // [2]

    init(value: String) { // [3]
        self.value = value
    }
}
@a2 a2 changed the title SwiftDoc only respects some ACL settings SwiftDoc only generates documentation for some non-public members Jul 2, 2020
@mattt mattt added the bug Something isn't working label Jul 14, 2020
@mattt
Copy link
Contributor

mattt commented Jul 14, 2020

Thanks so much for digging in and writing this up, @a2. It's as actionable a bug report as I've ever seen!

If you looked through the source and saw the gnarly bit of code responsible (or have ever tried to wrap your head around Swift ACL rules yourself), the existence of bugs like this should come as little surprise. I'll be sure to add tests around these cases and fix this for the forthcoming release.

@mattt mattt added this to the 1.0.0-beta.4 milestone Jul 14, 2020
@mattt
Copy link
Contributor

mattt commented Jul 31, 2020

Fixed by #131.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants