-
-
Notifications
You must be signed in to change notification settings - Fork 6.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Docs] ListItem InfoLabels Documentation Incomplete/Malformed #25151
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. Thanks.
The problem is only caused indirectly by this PR. Some parts of the documentation are now rendered for the first time, and there are syntax errors, namely: https://github.com/xbmc/xbmc/blob/master/xbmc/GUIInfoManager.cpp#L6491 Can you see it? ;-) There is one ` that needs to be removed. ``\endlink -> `\endlink |
@DeltaMikeCharlie are you interested in opening a PR to fix the problem @MikeSiLVO reported here? See my (untested) proposal for a fix. |
OK. |
Actually, there are some unescaped commas. Line 6913 in 5b97125
On both Chromium and Firefox on my Ubuntu development system, the first issue at the top of the list item has been fixed. |
Description
The current online documentation for ‘ListItem’ InfoLabels ends at ‘ListItem.AddonLifecycleDesc’, however, more labels are documented in the source file. There is also some malformed documentation in the ‘listitem_labels’ section of ‘GUIInfoManager.cpp’
A single empty line appears to interrupt the documentation creation process. Removing this empty line produces documentation up to ‘ListItem.HasVideoExtras’ (the last item documented in the source file) and removes the malformed documentation from ‘GUIInfoManager.cpp’.
Motivation and context
Provide accurate documentation.
How has this been tested?
What is the effect on users?
None. For developers only.
Screenshots (if appropriate):
Before
After
Types of change
Checklist: