View Issue Details

Related ChangesetsJump to NotesJump to History
IDProjectCategoryView StatusDate SubmittedLast Update
0029113Open CASCADEOCCT:Codingpublic2017-09-15 09:012018-06-29 21:19
ReporterabvAssigned Tobugmaster  
PrioritynormalSeverityminor 
Status closedResolutionfixed 
Target Version7.3.0Fixed in Version7.3.0 
Summary0029113: Coding Rules - fix convention to have one header per API type
DescriptionIn general, OCCT follows convention that each class is defined in its own header file with the same name. This helps to navigate across the code, e.g. to find easily definition of any type that follows that convention. This convention is also heavily used by the SWIG wrappers (simplifies implementation).

In the past, this convention has been enforced by WOK, but in the current no-WOK state it gets violated regularly (see e.g. 0029112). Alas, it is not recorded in the Coding Rules and this should be fixed at first.
Steps To ReproduceN/A
TagsNo tags attached.
Test case numberNot required

Relationships

related to 0029112 closedbugmaster Configuration, Image_VideoRecorder - compilation fails on Ubuntu with libavutil 54.x (FFmpeg 2.7.6) 

Activities

git

2017-09-15 10:52

administrator   ~0070572

Branch CR29113 has been created by abv.

SHA-1: 1a196d8582abf6cc52f106f857cc365f5dc905ea


Detailed log of new commits:

Author: abv
Date: Fri Sep 15 10:52:14 2017 +0300

    0029113: Coding Rules - fix convention to have one header per API type
    
    Paragraph on naming of classes is revised to describe correspondence of names of public types and files.

abv

2017-09-15 10:53

manager   ~0070573

Correction is pushed to CR29113, please review (documentation only, no testing is needed)

kgv

2017-09-15 12:14

developer   ~0070577

No remarks from my side.

ysn

2017-11-17 12:08

developer   ~0072314

No remarks.

git

2017-12-07 21:07

administrator   ~0072792

Branch CR29113 has been deleted by kgv.

SHA-1: 1a196d8582abf6cc52f106f857cc365f5dc905ea

Related Changesets

occt: master e7174545

2017-09-15 07:52:14

abv


Committer: bugmaster Details Diff		 0029113: Coding Rules - fix convention to have one header per API type

Paragraph on naming of classes is revised to describe correspondence of names of public types and files.		 Affected Issues
0029113
mod - dox/dev_guides/contribution/coding_rules.md Diff File

Issue History

Date Modified Username Field Change
2017-09-15 09:01 abv New Issue
2017-09-15 09:01 abv Assigned To => kgv
2017-09-15 09:04 abv Description Updated
2017-09-15 09:31 abv Relationship added related to 0029112
2017-09-15 10:52 git Note Added: 0070572
2017-09-15 10:53 abv Note Added: 0070573
2017-09-15 10:53 abv Status new => resolved
2017-09-15 10:53 abv Steps to Reproduce Updated
2017-09-15 12:14 kgv Note Added: 0070577
2017-09-15 12:14 kgv Assigned To kgv => ysn
2017-11-17 12:08 ysn Note Added: 0072314
2017-11-17 12:08 ysn Assigned To ysn => kgv
2017-11-17 12:11 kgv Assigned To kgv => bugmaster
2017-11-17 12:11 kgv Status resolved => reviewed
2017-11-20 11:36 bugmaster Test case number => Not required
2017-11-20 11:36 bugmaster Status reviewed => tested
2017-11-25 12:28 bugmaster Changeset attached => occt master e7174545
2017-11-25 12:28 bugmaster Status tested => verified
2017-11-25 12:28 bugmaster Resolution open => fixed
2017-12-07 21:07 git Note Added: 0072792
2018-02-18 00:11 abv Target Version 7.3.0 => 7.4.0
2018-02-20 12:58 aiv Target Version 7.4.0 => 7.3.0
2018-06-29 21:15 aiv Fixed in Version => 7.3.0
2018-06-29 21:19 aiv Status verified => closed