You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In my package, I have a type which is documented via a markdown extension doc. This looks great in the documentation browser, but I also want to provide great documentation in the Xcode alt+click popover.
Currently, the default appears to append the source docs with the extension docs, meaning I need to limit the popover docs to just the first line:
Code:
Popover:
Documentation browser (notice the summary up top comes from the source docs):
Now, if I extend the source docs with a longer (yet still abbreviated) summary, I get a better popover experience, but the documentation browser duplicates it, with 2 overview sections:
Popover:
Documentation browser:
Now, if I add specify the "override" merge behaviour in the markdown document, I can remove the duplicated content in the documentation browser, but now get absolutely no popover documentation at all, despite there obviously being documentation which you can see in the background.
This means I'm not able to provide a great popover and documentation browser experience simultaneously 🙁
The text was updated successfully, but these errors were encountered:
Attachment: Download
Environment
macOS 11.6, Xcode 13.2.1 (13C100)
Additional Detail from JIRA
md5: ee66e5044a4c31ce0a974d83ef42f904
Issue Description:
In my package, I have a type which is documented via a markdown extension doc. This looks great in the documentation browser, but I also want to provide great documentation in the Xcode alt+click popover.
Currently, the default appears to append the source docs with the extension docs, meaning I need to limit the popover docs to just the first line:
Code:
Popover:
Documentation browser (notice the summary up top comes from the source docs):
Now, if I extend the source docs with a longer (yet still abbreviated) summary, I get a better popover experience, but the documentation browser duplicates it, with 2 overview sections:
Popover:
Documentation browser:
Now, if I add specify the "override" merge behaviour in the markdown document, I can remove the duplicated content in the documentation browser, but now get absolutely no popover documentation at all, despite there obviously being documentation which you can see in the background.
This means I'm not able to provide a great popover and documentation browser experience simultaneously 🙁
The text was updated successfully, but these errors were encountered: