Documentation of Internal protocol is not inherited by conforming public types at documentation generation #7
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
Either when generating or previewing the
DocCdocumentation of the library via the command line, those public types that conforms to theAPIClient,KeyNameFilter, andKeyNameModelinternal protocols are not inheriting the documentation for its properties and functions from those protocols.Explanation
Basically, the documentation of those properties and/or functions for the types conforming to those internal protocols mentioned in the Summary section have no documentation whatsoever. No matter if the documentation is being generated or preview from the command line.
I also tried including the
--enable-inherited-docsflag inside the documentation tasks in theMakefile, that is documented in the help for theswift package generate-documentationor theswift package preview-documentationcommands, without avail.Steps to reproduce
make doc-generateor themake doc-previewin the command line.AmiiboLiveClientAmiiboMockClientAmiiboSeriesFilterAmiiboTypeFilterGameCharacterFilterGameSeriessFilterAmiiboSeriesAmiiboTypeGameCharacterGameSeriesExtra details
When generating the
DocCdocumentation directly from Xcode, either by selecting theProduct > Build Documentationoption from the menu or by using theControl + Shift + Command + Dshortcut keys; this issue doesn't occur as any property and/or function of the types conforming to those internal protocols mentioned in the Summary section actually do inherit the documentation written from the m mentioned protocols.However, this way of generating the
DocCdocumentation doesn't make use of theAmiiboServicedocumentation catalog in theCatalogsfolder of the library unless the documentation catalog is located inside the library folder.I'm closing this issue for the moment, as it is not a priority to fix it.