Archived issue #0031363
Documentation - broken Doxygen documentation of header files in Standard package
Description
Doxygen comment is formatted incorrectly in files Standard_WarningsDisable.hxx and Standard_WarningsRestore.hxx: the @file statement is followed by description which is interpreted as name of the file documented. Instead it should be followed by newline for it to be interpreted as documentation to the current file.
The effect is that this documentation is lost from Doxygen putput, see e.g.
https://www.opencascade.com/doc/occt-7.3.0/refman/html/_standard___warnings_restore_8hxx.html
The effect is that this documentation is lost from Doxygen putput, see e.g.
https://www.opencascade.com/doc/occt-7.3.0/refman/html/_standard___warnings_restore_8hxx.html
Steps to reproduce
Generate reference manual for Foundation Classes, then see documentation of Standard_WarningsRestore.hxx
Public activity
5 archived notes
Participants are labeled by their role within this record.
Branch [archived branch] has been created by Author.
[revision removed]
Detailed log of new commits:
Author: Author
Date: Mon Feb 10 10:25:15 2020 +0300
0031363: Documentation - broken Doxygen documentation of header files in Standard package
Documentation is corrected
[revision removed]
Detailed log of new commits:
Author: Author
Date: Mon Feb 10 10:25:15 2020 +0300
0031363: Documentation - broken Doxygen documentation of header files in Standard package
Documentation is corrected
Fix is pushed to CR31363, please review. No testing is needed
Branch [archived branch] has been updated forcibly by Author.
[revision removed]
[revision removed]
Tested in framework of WEEK-7
Combination -
OCCT branch : [archived branch]
master SHA - [revision removed]
[revision removed]
Products branch : [archived branch] SHA - [revision removed]
was compiled on Linux, MacOS and Windows platforms and tested in optimize mode.
Number of compiler warnings:
No new/fixed warnings
Regressions/Differences/Improvements:
No regressions/differences
CPU differences:
Debian80-64:
OCCT
Total CPU difference: 16972.490000000067 / 16995.740000000096 [-0.14%]
Products
Total CPU difference: 11439.249999999975 / 11455.569999999962 [-0.14%]
Windows-64-VC14:
OCCT
Total CPU difference: 18436.9375 / 18439.6875 [-0.01%]
Products
Total CPU difference: 13329.09375 / 13351.46875 [-0.17%]
Image differences :
No differences that require special attention
Memory differences :
No differences that require special attention
Combination -
OCCT branch : [archived branch]
master SHA - [revision removed]
[revision removed]
Products branch : [archived branch] SHA - [revision removed]
was compiled on Linux, MacOS and Windows platforms and tested in optimize mode.
Number of compiler warnings:
No new/fixed warnings
Regressions/Differences/Improvements:
No regressions/differences
CPU differences:
Debian80-64:
OCCT
Total CPU difference: 16972.490000000067 / 16995.740000000096 [-0.14%]
Products
Total CPU difference: 11439.249999999975 / 11455.569999999962 [-0.14%]
Windows-64-VC14:
OCCT
Total CPU difference: 18436.9375 / 18439.6875 [-0.01%]
Products
Total CPU difference: 13329.09375 / 13351.46875 [-0.17%]
Image differences :
No differences that require special attention
Memory differences :
No differences that require special attention
Branch [archived branch] has been deleted by Participant.
[revision removed]
[revision removed]
Related records