View Issue Details

IDProjectCategoryView StatusLast Update
0032250Open CASCADEOCCT:Documentationpublic2021-09-29 19:00
Reporterkgv Assigned Tobugmaster  
PrioritynormalSeverityminor 
Status closedResolutionfixed 
Product Version7.5.0 
Target Version7.6.0Fixed in Version7.6.0 
Summary0032250: Documentation - pseudographics within gp_Trsf description is not properly escaped
Descriptiongp_Trsf description contains pseudographics which is not escaped and converted into broken text by Doxygen:

//! V1   V2   V3    T       XYZ        XYZ
//! | a11  a12  a13   a14 |   | x |      | x'|
//! | a21  a22  a23   a24 |   | y |      | y'|
//! | a31  a32  a33   a34 |   | z |   =  | z'|
//! |  0    0    0     1  |   | 1 |      | 1 |
//!
Steps To ReproduceN/A
TagsNo tags attached.
Test case numberNot required

Attached Files

  • gp_Trsf_docs.png (12,601 bytes)

Activities

kgv

2021-03-27 10:04

developer  

gp_Trsf_docs.png (12,601 bytes)

git

2021-03-27 14:45

administrator   ~0099789

Branch CR32250 has been created by kgv.

SHA-1: d4a8ebf0013d0e2bf12f693c312b25bc831a5b17


Detailed log of new commits:

Author: kgv
Date: Sat Mar 27 14:45:06 2021 +0300

    0032250: Documentation - pseudographics within gp_Trsf description is not properly escaped
    
    Added @code tags to documentation of several classes in the package gp.

kgv

2021-03-27 15:44

developer   ~0099790

Patch is ready for review
- OCCT: branch CR32250.

abv

2021-03-29 21:40

manager   ~0099833

Reviewed, please integrate.

Would not it be reasonable to use TeX formulae (supported in Doxygen via MathJAX) instead of @code where math expressions are included?

kgv

2021-03-29 21:49

developer   ~0099834

I've though about TeX, but I guess that this would make formulae unreadable in IDE editor - good for HTML export, but not that nice for developer.

bugmaster

2021-04-03 11:56

administrator   ~0100017

Combination -
OCCT branch : IR-2021-04-02
master SHA - 5e4f263d1cfd948e6a91aa584919bb6d86256a86
a87b7ddc8cb44606b91e3f37113847c3f5f50fdc
Products branch : IR-2021-04-02 SHA - 7cc5f9bb4eb61152ffc5290516ae20c649a33a55
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: 18055.90000000045 / 18179.810000000525 [-0.68%]
Products
Total CPU difference: 11506.800000000105 / 11565.220000000114 [-0.51%]
Windows-64-VC14:
OCCT
Total CPU difference: 19512.09375 / 19430.5 [+0.42%]
Products
Total CPU difference: 12943.234375 / 12843.765625 [+0.77%]


Image differences :
No differences that require special attention

Memory differences :
No differences that require special attention

git

2021-04-03 12:50

administrator   ~0100061

Branch CR32250 has been deleted by inv.

SHA-1: d4a8ebf0013d0e2bf12f693c312b25bc831a5b17

git

2021-09-29 18:29

administrator   ~0104434

Branch CR32250 has been updated by oleg.korchagin@opencascade.com in OCCT Products internal repository.

SHA-1: b3e3ccb100707abaf89297700ff47913a31def95


git

2021-09-29 18:46

administrator   ~0104435

Branch CR32250 has been updated by oleg.korchagin@opencascade.com in OCCT Products internal repository.

SHA-1: 5dff323f0e8ff16098078ec1ab8b5b8d45e7e404


git

2021-09-29 18:51

administrator   ~0104436

Branch CR32250 has been updated by oleg.korchagin@opencascade.com in OCCT Products internal repository.

SHA-1: cba6b1eecf9dbc4a2f3cf8a1483bab07315a3068


git

2021-09-29 18:55

administrator   ~0104437

Branch CR32250 has been updated by oleg.korchagin@opencascade.com in OCCT Products internal repository.

SHA-1: ed55e2b7769c153d5b4d07e39e3a8b8e96d551cf


git

2021-09-29 19:00

administrator   ~0104438

Branch CR32250 has been updated by oleg.korchagin@opencascade.com in OCCT Products internal repository.

SHA-1: e2d5ab821f8a991b54a754e0c96149a38a733484


Related Changesets

occt: master 08eda8e3

2021-03-27 11:45:06

kgv


Committer: bugmaster Details Diff
0032250: Documentation - pseudographics within gp_Trsf description is not properly escaped

Added @code tags to documentation of several classes in the package gp.
Affected Issues
0032250
mod - src/gp/gp_Elips.hxx Diff File
mod - src/gp/gp_Elips2d.hxx Diff File
mod - src/gp/gp_GTrsf.hxx Diff File
mod - src/gp/gp_GTrsf2d.hxx Diff File
mod - src/gp/gp_Hypr.hxx Diff File
mod - src/gp/gp_Hypr2d.hxx Diff File
mod - src/gp/gp_Mat.hxx Diff File
mod - src/gp/gp_Mat2d.hxx Diff File
mod - src/gp/gp_Parab.hxx Diff File
mod - src/gp/gp_Parab2d.hxx Diff File
mod - src/gp/gp_Pln.hxx Diff File
mod - src/gp/gp_Quaternion.hxx Diff File
mod - src/gp/gp_Sphere.hxx Diff File
mod - src/gp/gp_Torus.hxx Diff File
mod - src/gp/gp_Trsf.hxx Diff File
mod - src/gp/gp_Trsf2d.hxx Diff File
mod - src/gp/gp_XY.hxx Diff File
mod - src/gp/gp_XYZ.hxx Diff File

Issue History

Date Modified Username Field Change
2021-03-27 10:04 kgv New Issue
2021-03-27 10:04 kgv Assigned To => abv
2021-03-27 10:04 kgv File Added: gp_Trsf_docs.png
2021-03-27 14:45 git Note Added: 0099789
2021-03-27 15:44 kgv Note Added: 0099790
2021-03-27 15:44 kgv Status new => resolved
2021-03-29 21:40 abv Note Added: 0099833
2021-03-29 21:40 abv Assigned To abv => bugmaster
2021-03-29 21:40 abv Status resolved => reviewed
2021-03-29 21:49 kgv Note Added: 0099834
2021-04-03 11:56 bugmaster Note Added: 0100017
2021-04-03 11:56 bugmaster Status reviewed => tested
2021-04-03 12:01 bugmaster Test case number => Not required
2021-04-03 12:13 bugmaster Changeset attached => occt master 08eda8e3
2021-04-03 12:13 bugmaster Status tested => verified
2021-04-03 12:13 bugmaster Resolution open => fixed
2021-04-03 12:50 git Note Added: 0100061
2021-09-29 18:29 git Note Added: 0104434
2021-09-29 18:46 git Note Added: 0104435
2021-09-29 18:51 git Note Added: 0104436
2021-09-29 18:55 git Note Added: 0104437
2021-09-29 19:00 git Note Added: 0104438