Opened 6 years ago

Closed 5 years ago

#14944 closed bug (fixed)

incorrect generation of API doumentation in doxygen 1.8.13

Reported by: Bhumnay Owned by: haiku-web
Priority: normal Milestone: R1
Component: Sys-Admin Version: R1/Development
Keywords: Cc: pulkomandy
Blocked By: Blocking:
Platform: All

Description

On generating documentation using doxygen 1.7 for docs/user/interface/Font.dox one can see all 5 operators under the class unicode_block but using latest version of doxygen 1.8.13 it lists 4 of them only-https://www.haiku-os.org/docs/api/classunicode__block.html

Change History (3)

comment:1 by pulkomandy, 6 years ago

Component: - GeneralSys-Admin
Keywords: API removed
Milestone: UnscheduledR1
Owner: changed from nobody to haiku-web

To be clear: the documentation of operator&() is missing from the generated docs. I have confirmed that this issue isn't there when generating with Doxygen 1.7.

I found this possibly related issue: https://github.com/doxygen/doxygen/issues/6295 with a similar fix shipped in Doxygen 1.8.15. We should confirm that it fixes the problem, and if it does, update our servers to use that version or a newer one to render api.haiku-os.org

comment:2 by waddlesplash, 6 years ago

From the site build log:

10:00:30 PM: /opt/build/repo/haiku/docs/user/interface/Font.dox:476: warning: documented symbol `unicode_block unicode_block::operator &' was not declared or defined.
10:00:31 PM: /opt/build/repo/haiku/docs/user/interface/Rect.dox:692: warning: documented symbol `BRect BRect::operator &' was not declared or defined.
10:00:31 PM: /opt/build/repo/haiku/headers/os/interface/Font.h:358: warning: documented symbol `unicode_block unicode_block::operator &' was not declared or defined.

Indeed.

comment:3 by pulkomandy, 5 years ago

Resolution: fixed
Status: newclosed

We are now running Doxygen 1.8.16 and that fixed the problem.

Note: See TracTickets for help on using tickets.