MantisBT - Open CASCADE
View Issue Details
0031363Open CASCADE[OCCT] OCCT:Documentationpublic2020-02-10 10:232020-02-23 12:25
abv 
bugmaster 
normalminor 
verifiedfixed 
[OCCT] 7.3.0 
[OCCT] 7.5.0* 
Not required
0031363: Documentation - broken Doxygen documentation of header files in Standard package
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 [^]
Generate reference manual for Foundation Classes, then see documentation of Standard_WarningsRestore.hxx
No tags attached.
related to 0031365new abv Documentation - Doxygen warnings when generating Reference Manual 
child of 0029310closed bugmaster Coding - multiple compiler warnings in Inspectors 
Issue History
2020-02-10 10:23abvNew Issue
2020-02-10 10:23abvAssigned To => abv
2020-02-10 10:25gitNote Added: 0090441
2020-02-10 10:26abvNote Added: 0090442
2020-02-10 10:26abvAssigned Toabv => kgv
2020-02-10 10:26abvStatusnew => resolved
2020-02-10 10:26abvSteps to Reproduce Updatedbug_revision_view_page.php?rev_id=22534#r22534
2020-02-10 10:35kgvRelationship addedchild of 0029310
2020-02-10 10:36kgvAssigned Tokgv => bugmaster
2020-02-10 10:36kgvStatusresolved => reviewed
2020-02-10 10:36kgvProduct Version => 7.3.0
2020-02-10 10:56gitNote Added: 0090445
2020-02-10 10:58abvRelationship addedrelated to 0031365
2020-02-12 13:54bugmasterNote Added: 0090489
2020-02-12 13:54bugmasterStatusreviewed => tested
2020-02-12 13:56bugmasterTest case number => Not required
2020-02-15 14:55bugmasterChangeset attached => occt master 64e68ea6
2020-02-15 14:55bugmasterStatustested => verified
2020-02-15 14:55bugmasterResolutionopen => fixed
2020-02-23 12:25gitNote Added: 0090652

Notes
(0090441)
git   
2020-02-10 10:25   
Branch CR31363 has been created by abv.

SHA-1: 0abe901d923a10a6908b0bba084cb50122337afe


Detailed log of new commits:

Author: abv
Date: Mon Feb 10 10:25:15 2020 +0300

    0031363: Documentation - broken Doxygen documentation of header files in Standard package
    
    Documentation is corrected
(0090442)
abv   
2020-02-10 10:26   
Fix is pushed to CR31363, please review. No testing is needed
(0090445)
git   
2020-02-10 10:56   
Branch CR31363 has been updated forcibly by abv.

SHA-1: 1fd8c6fff47ad40b712f8c6b74498005e5b3a319
(0090489)
bugmaster   
2020-02-12 13:54   
Tested in framework of WEEK-7

Combination -
OCCT branch : WEEK-7
master SHA - ed81d053016438d0b36485eefa9da2a90616f824
fe4497f3246e6bc1ced97ac331c148f0809ded15
Products branch : WEEK-7 SHA - fa93736d0dfc60600eb038f1a228db0ca19b8500
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
(0090652)
git   
2020-02-23 12:25   
Branch CR31363 has been deleted by inv.

SHA-1: 1fd8c6fff47ad40b712f8c6b74498005e5b3a319