Login at Kodi Home

DeltaMikeCharlie · 2024-05-06, 07:29

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/mast...99566a1ea1

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/431372...1-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.

DeltaMikeCharlie · 2024-05-06, 08:30

It’s even worse (or better, depending upon your perspective).

The empty line (6495) between these two items:

https://github.com/xbmc/xbmc/blob/431372...C7-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.

**Hitcher** · 2024-05-06, 09:19

PR would be very welcome.

DeltaMikeCharlie · 2024-05-06, 11:03

Fixing the second problem (removing the blank line) made the first problem go away.

DeltaMikeCharlie · 2024-05-06, 22:26

(2024-05-06, 09:19)Hitcher Wrote: PR would be very welcome.

https://github.com/xbmc/xbmc/pull/25151

**Hitcher** · 2024-05-06, 23:03

Thanks.

**scott967** · 2024-05-08, 06:14

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.
.

DeltaMikeCharlie · 2024-05-08, 23:31

With Kodi, Doxygen produced HTML files.

The following link explains how to build the documentation.

https://github.com/xbmc/xbmc/blob/master.../README.md

**scott967** · 2024-05-09, 01:03

(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.../README.md

Thanks. Still would be nice if there was a syntax checker or something like that.

DeltaMikeCharlie · 2024-05-09, 02:19

(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