Fix declarations for undocumented symbols

[johnfairh]

First step towards improved Swift declarations. This PR fixes/adds declarations for undocumented symbols: currently these symbols either get no declaration or (wrongly) get a copy of their parent's declaration (#864).

I think it is useful to include the declarations for undocumented symbols in the docs: helps users understand the API; from the spec projects is not uncommon to leave some members uncommented.

Specs changes, pretty ugly in the (common) 'wrong parent decl -> correct decl' case :/

misc_jazzy_objc_features

• Add decls for undocumented symbols

document_moya_podspec

• CancellableToken, CredentialsPlugin, Endpoint, MoyaProvider, NetworkActivityPlugin, NetworkLoggerPlugin, Response, AuthorizationType, MultiTarget, NetworkActivityChangeType, Method, SignalProducerProtocol, Cancellable, TargetType, FormDataProvider - fix incorrect member decls
• MoyaError, convertResponseToResult(_:request:data:error:), MoyaProviderType, ProgressResponse - add decl for undocumented symbols

document_realm_swift

• Object - remove incorrect declaration from #ifdef’d out version of className.

document_siesta

• RequestError.Cause.* -- fix incorrect member decls

misc_jazzy_features

• Various, add decls for undocumented symbols & fix incorrect member decls.
• Add specific new test for #ifdef case.
• Minor change to how unwanted generic type params are documented - still wrong though.

[jpsim]

Looking good! The #ifdef case definitely still needs work, but that's out of scope for this PR.

[johnfairh]

I rebased this to fix conflicts + CI fell over because shields.io have tweaked the badge format. Tempting to take this file out of the CI compare but have kept it for now -- useful to check jazzy is sending the right commands to create a badge at all.

[jpsim]

Ugh, sorry about that. That doesn't sound fun. Ideally, I'd like to just generate those SVGs locally in jazzy itself, rather than have to make a network call.

[SDGGiesbrecht]

I’d like to just generate those SVGs locally in jazzy itself, rather than have to make a network call.

I run diff in CI to verify documentation is up‐to‐date and not forgotten, and this, combined with network fluctuations, causes false positives/negatives up to about 10% of the time some weeks.

Needless to say, such a change would be a very welcome!

[segiddins]

I have SVG generation working locally

[sw-tt-ravivora]

Hi,
Is this issue is fixed ?

[johnfairh]

@sw-tt-ravivora this PR was included in release 0.9.0. Please open a fresh issue if you're seeing a problem!