+- Kodi Community Forum (https://forum.kodi.tv)
+-- Forum: Development (https://forum.kodi.tv/forumdisplay.php?fid=32)
+--- Forum: Kodi Application (https://forum.kodi.tv/forumdisplay.php?fid=93)
+--- Thread: Documentation anomaly with GUIInfoManager.cpp (/showthread.php?tid=377419)
Documentation anomaly with GUIInfoManager.cpp - DeltaMikeCharlie - 2024-05-06
I was experimenting with building my own Doxygen documentation and I noticed an issue with GUIInfoManager.cpp.
Also see: https://xbmc.github.io/docs.kodi.tv/master/kodi-base/d7/d66/_g_u_i_info_manager_8cpp.html#a2a31a01f38c4ffcea7af3799566a1ea1
The horizontal separator appears to be cutting the label description in half rather than providing separation between labels.
Looking at the source code, it would appear that the `<p>`and `<p><hr>` tag sequences are the wrong way around.
https://github.com/xbmc/xbmc/blob/4313724b4bdff8fd83b47606692f0a641b177cd5/xbmc/GUIInfoManager.cpp#L6496C1-L6521C54
I made the proposed changes on my test system and it appears that it worked.
I’m happy to make this change and submit a PR.
Does anyone want to double-check this before I proceed? Maybe I missed something.
RE: Documentation anomaly with GUIInfoManager.cpp - DeltaMikeCharlie - 2024-05-06
It’s even worse (or better, depending upon your perspective).
The empty line (6495) between these two items:
https://github.com/xbmc/xbmc/blob/4313724b4bdff8fd83b47606692f0a641b177cd5/xbmc/GUIInfoManager.cpp#L6486C7-L6504C8
Was preventing the items following from being included in the documentation. The horizontal bars are actually in the right place for InfoLabel list, but not the file-specific documentation as highlighted earlier.
Removing the empty line completed the InfoLabel list.
RE: Documentation anomaly with GUIInfoManager.cpp - Hitcher - 2024-05-06
PR would be very welcome.
RE: Documentation anomaly with GUIInfoManager.cpp - DeltaMikeCharlie - 2024-05-06
Fixing the second problem (removing the blank line) made the first problem go away.
RE: Documentation anomaly with GUIInfoManager.cpp - DeltaMikeCharlie - 2024-05-06
(2024-05-06, 09:19)Hitcher Wrote: PR would be very welcome.
https://github.com/xbmc/xbmc/pull/25151
RE: Documentation anomaly with GUIInfoManager.cpp - Hitcher - 2024-05-06
Thanks.
RE: Documentation anomaly with GUIInfoManager.cpp - scott967 - 2024-05-08
Is there a good way to test this? I did install a doxygen app on windows, but not sure how best to use it. I see many doxy extensions in vs code, but seem to be geared to generating comments, not building the html for review.
scott s.
.
RE: Documentation anomaly with GUIInfoManager.cpp - DeltaMikeCharlie - 2024-05-08
With Kodi, Doxygen produced HTML files.
The following link explains how to build the documentation.
https://github.com/xbmc/xbmc/blob/master/docs/doxygen/README.md
RE: Documentation anomaly with GUIInfoManager.cpp - scott967 - 2024-05-09
(2024-05-08, 23:31)DeltaMikeCharlie Wrote: With Kodi, Doxygen produced HTML files.
The following link explains how to build the documentation.
https://github.com/xbmc/xbmc/blob/master/docs/doxygen/README.md
Thanks. Still would be nice if there was a syntax checker or something like that.
RE: Documentation anomaly with GUIInfoManager.cpp - DeltaMikeCharlie - 2024-05-09
(2024-05-09, 01:03)scott967 Wrote: Thanks. Still would be nice if there was a syntax checker or something like that.
That sort of is the syntax checker. Make the documentation change, build the documentation and see if it messes up the HTML.
I also take our point, however: If your IDE could highlight the syntax error as you made it, that would be helpful.
A quick Google search found this: https://github.com/Sedeniono/VSDoxyHighlighter