Archived issue #0031635
Documentation - minor clean-up of User Guide for Foundation Classes module
Description
It is desired to clean up User Guides text from minor mistakes / misprints / old or non-existing OCCT classes.
Steps to reproduce
N/A
Public activity
13 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: Fri Jun 26 23:49:48 2020 +0300
0031635: Documentation - minor clean-up of User Guide for Foundation Classes module
Changes in Technical Overview.
Corrected reference of "Mesh" as dedicated module, which is actually a Toolkit within "Modeling Algorithms" module.
Reduced references to "Configurable optimized memory manager",
which has not been updated for a long time and no more encouraged to be used as replacement of standard memory allocator of C library.
VRML/STL converters have been moved from section Mesh to Data Exchange.
Visualization chapter has been slightly reworded and reordered;
added references to PBR metallic-roughness material model.
Data Exchange chapter - reworded sentence "The exchanges run smoothly regardless of the quality of external data..."
to "This module handles various problems of interoperability between CAD systems...";
added AP242 to the list of STEP capabilities.
Removed references to "physical quantities" in package Quanity, deprecated since #0028799 and not actually used anywhere.
Adjusted description of string classes to avoid duplicated statements.
Collections section has been refactored to replace obsolete TCollection references by NCollection.
Remove obsolete statement "furthermore *catch()* statement does not allow passing exception object as argument".
Fixed broken nested enumeration in a couple of places.
Fixed usage of inappropriate quote symbols in code snippets.
Fixed references to non-existing classes like ZeroDivide instead of Standard_DivideByZero.
Removed suggested usage of Standard_Failure::Raise() instead of "throw Standard_Failure()" following #0026937.
Code snippets now suggest "catch(const Standard_Failure& )" instead of "catch(Standard_Failure )" (#0026937).
Fixed broken code snippets with lost symbols like <<.
Cosmetics: removed numerous trailing spaces, double spaces.
Added missing {.cpp} language qualifier to code quotations.
Sentences within paragraphs have been split into multiple lines in source file.
[revision removed]
Detailed log of new commits:
Author: Author
Date: Fri Jun 26 23:49:48 2020 +0300
0031635: Documentation - minor clean-up of User Guide for Foundation Classes module
Changes in Technical Overview.
Corrected reference of "Mesh" as dedicated module, which is actually a Toolkit within "Modeling Algorithms" module.
Reduced references to "Configurable optimized memory manager",
which has not been updated for a long time and no more encouraged to be used as replacement of standard memory allocator of C library.
VRML/STL converters have been moved from section Mesh to Data Exchange.
Visualization chapter has been slightly reworded and reordered;
added references to PBR metallic-roughness material model.
Data Exchange chapter - reworded sentence "The exchanges run smoothly regardless of the quality of external data..."
to "This module handles various problems of interoperability between CAD systems...";
added AP242 to the list of STEP capabilities.
Removed references to "physical quantities" in package Quanity, deprecated since #0028799 and not actually used anywhere.
Adjusted description of string classes to avoid duplicated statements.
Collections section has been refactored to replace obsolete TCollection references by NCollection.
Remove obsolete statement "furthermore *catch()* statement does not allow passing exception object as argument".
Fixed broken nested enumeration in a couple of places.
Fixed usage of inappropriate quote symbols in code snippets.
Fixed references to non-existing classes like ZeroDivide instead of Standard_DivideByZero.
Removed suggested usage of Standard_Failure::Raise() instead of "throw Standard_Failure()" following #0026937.
Code snippets now suggest "catch(const Standard_Failure& )" instead of "catch(Standard_Failure )" (#0026937).
Fixed broken code snippets with lost symbols like <<.
Cosmetics: removed numerous trailing spaces, double spaces.
Added missing {.cpp} language qualifier to code quotations.
Sentences within paragraphs have been split into multiple lines in source file.
Patch is ready for review in OCCT branch CR31635.
Branch [archived branch] has been updated forcibly by Author.
[revision removed]
[revision removed]
Dear Kirill,
please, have a look at attached document. May be there's something to change inside this issue or skip/postpone.
[signature removed]Natalia
please, have a look at attached document. May be there's something to change inside this issue or skip/postpone.
[signature removed]Natalia
Branch [archived branch] has been updated by Author.
[revision removed]
Detailed log of new commits:
Author: Author
Date: Wed Jul 1 21:12:51 2020 +0300
# applying remarks
[revision removed]
Detailed log of new commits:
Author: Author
Date: Wed Jul 1 21:12:51 2020 +0300
# applying remarks
> 1. having toolkit and module on the same level in the list;
Moved to another level.
> 1. on the image toolkit has the same color/style/size as parent module.
Blue color on the image indicates "Open" component in legenda.
I think that reworking this image is subject for another bug.
> 2. It’s not clear what is the grammar base of the sentence (never find the verb)
The section has been reworked.
> 3. The presentations can be customized to take
Removed
> 4. AP242 - not whole functionality is supported, isn’t it?
This list describes the key objective of specific AP version, not the part implemented by OCCT.
In some contexts AP242 is desribed as "Managed Model Based 3D Engineering" - dunno if this description should be added.
> 5. Now, we have no CDL or WOK. Why the user need to read/think about them here?
Reworded to remove mentioning of CDL/WOK.
> 6. The caption tells which container is described.
Remove a couple of occurences.
> 7. may be let’s say: ”OCCT provides …”
Applied
> 8. Maps serve to describe a combination key to value,
Reworded.
> 9. Caption “Collection of maps” inside the “Maps” is not clear.
Redundant chapters have been merged and filtered.
> 10. Init, More, Next, Value are not very accented/visible/pointed here
Replaced by table.
> 11. Some packages might define a dedicated Iterator classes like
This code is still used in OCCT API and not replaced by ::Iterator analogs.
So that it might be helpful to user to know the difference.
Notice has been removed, as proposed.
> 12. BVH_Tree description is absent (link to outside description is also absent)
Shared documentation has been built without C++ classes references - so that in real documentation it will have an URL to class.
BVH_Tree requires a more comprehensive description, similar to UBTree, which is a good subject of another issue.
In this modification, I have tried to structure collections into distinguishable groups,
and it is difficult to omit BVH_Tree from the list of acceleration structures, even if it does not have yet a good description.
> 13. What containers are mentioned below?
Section has been truncated.
Moved to another level.
> 1. on the image toolkit has the same color/style/size as parent module.
Blue color on the image indicates "Open" component in legenda.
I think that reworking this image is subject for another bug.
> 2. It’s not clear what is the grammar base of the sentence (never find the verb)
The section has been reworked.
> 3. The presentations can be customized to take
Removed
> 4. AP242 - not whole functionality is supported, isn’t it?
This list describes the key objective of specific AP version, not the part implemented by OCCT.
In some contexts AP242 is desribed as "Managed Model Based 3D Engineering" - dunno if this description should be added.
> 5. Now, we have no CDL or WOK. Why the user need to read/think about them here?
Reworded to remove mentioning of CDL/WOK.
> 6. The caption tells which container is described.
Remove a couple of occurences.
> 7. may be let’s say: ”OCCT provides …”
Applied
> 8. Maps serve to describe a combination key to value,
Reworded.
> 9. Caption “Collection of maps” inside the “Maps” is not clear.
Redundant chapters have been merged and filtered.
> 10. Init, More, Next, Value are not very accented/visible/pointed here
Replaced by table.
> 11. Some packages might define a dedicated Iterator classes like
This code is still used in OCCT API and not replaced by ::Iterator analogs.
So that it might be helpful to user to know the difference.
Notice has been removed, as proposed.
> 12. BVH_Tree description is absent (link to outside description is also absent)
Shared documentation has been built without C++ classes references - so that in real documentation it will have an URL to class.
BVH_Tree requires a more comprehensive description, similar to UBTree, which is a good subject of another issue.
In this modification, I have tried to structure collections into distinguishable groups,
and it is difficult to omit BVH_Tree from the list of acceleration structures, even if it does not have yet a good description.
> 13. What containers are mentioned below?
Section has been truncated.
Branch [archived branch] has been updated forcibly by Author.
[revision removed]
[revision removed]
Branch [archived branch] has been updated forcibly by Author.
[revision removed]
[revision removed]
Branch [archived branch] has been created by Author.
[revision removed]
Detailed log of new commits:
Author: Author
Date: Fri Jun 26 23:49:48 2020 +0300
0031635: Documentation - minor clean-up of User Guide for Foundation Classes module
Changes in Technical Overview:
Corrected reference of "Mesh" as dedicated module, which is actually a Toolkit within "Modeling Algorithms" module.
Reduced references to "Configurable optimized memory manager",
which has not been updated for a long time and no more encouraged to be used as replacement of standard memory allocator of C library.
VRML/STL converters have been moved from section Mesh to Data Exchange.
Visualization chapter has been slightly reworded and reordered;
added references to PBR metallic-roughness material model.
Data Exchange chapter - reworded sentence "The exchanges run smoothly regardless of the quality of external data..."
to "This module handles various problems of interoperability between CAD systems...";
added AP242 to the list of STEP capabilities.
Changes in User Guide for Foundation Classes:
Removed references to "physical quantities" in package Quanity, deprecated since #0028799 and not actually used anywhere.
Adjusted description of string classes to avoid duplicated statements.
Collections section has been refactored to replace obsolete TCollection references by NCollection.
Remove obsolete statement "furthermore *catch()* statement does not allow passing exception object as argument".
Fixed broken nested enumeration in a couple of places.
Fixed usage of inappropriate quote symbols in code snippets.
Fixed references to non-existing classes like ZeroDivide instead of Standard_DivideByZero.
Removed suggested usage of Standard_Failure::Raise() instead of "throw Standard_Failure()" following #0026937.
Code snippets now suggest "catch(const Standard_Failure& )" instead of "catch(Standard_Failure )" (#0026937).
Fixed broken code snippets with lost symbols like <<.
Cosmetics: removed numerous trailing spaces, double spaces.
Added missing {.cpp} language qualifier to code quotations.
Sentences within paragraphs have been split into multiple lines in source file.
[revision removed]
Detailed log of new commits:
Author: Author
Date: Fri Jun 26 23:49:48 2020 +0300
0031635: Documentation - minor clean-up of User Guide for Foundation Classes module
Changes in Technical Overview:
Corrected reference of "Mesh" as dedicated module, which is actually a Toolkit within "Modeling Algorithms" module.
Reduced references to "Configurable optimized memory manager",
which has not been updated for a long time and no more encouraged to be used as replacement of standard memory allocator of C library.
VRML/STL converters have been moved from section Mesh to Data Exchange.
Visualization chapter has been slightly reworded and reordered;
added references to PBR metallic-roughness material model.
Data Exchange chapter - reworded sentence "The exchanges run smoothly regardless of the quality of external data..."
to "This module handles various problems of interoperability between CAD systems...";
added AP242 to the list of STEP capabilities.
Changes in User Guide for Foundation Classes:
Removed references to "physical quantities" in package Quanity, deprecated since #0028799 and not actually used anywhere.
Adjusted description of string classes to avoid duplicated statements.
Collections section has been refactored to replace obsolete TCollection references by NCollection.
Remove obsolete statement "furthermore *catch()* statement does not allow passing exception object as argument".
Fixed broken nested enumeration in a couple of places.
Fixed usage of inappropriate quote symbols in code snippets.
Fixed references to non-existing classes like ZeroDivide instead of Standard_DivideByZero.
Removed suggested usage of Standard_Failure::Raise() instead of "throw Standard_Failure()" following #0026937.
Code snippets now suggest "catch(const Standard_Failure& )" instead of "catch(Standard_Failure )" (#0026937).
Fixed broken code snippets with lost symbols like <<.
Cosmetics: removed numerous trailing spaces, double spaces.
Added missing {.cpp} language qualifier to code quotations.
Sentences within paragraphs have been split into multiple lines in source file.
Branches for integration:
OCCT – CR31635_1
Products – NOT
OCCT – CR31635_1
Products – NOT
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: 17174.900000000107 / 17168.64000000016 [+0.04%]
Products
Total CPU difference: 11226.760000000077 / 11202.250000000082 [+0.22%]
Windows-64-VC14:
OCCT
Total CPU difference: 18704.34375 / 18712.96875 [-0.05%]
Products
Total CPU difference: 13043.15625 / 13084.109375 [-0.31%]
Image differences :
No differences that require special attention
Memory differences :
No differences that require special attention
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: 17174.900000000107 / 17168.64000000016 [+0.04%]
Products
Total CPU difference: 11226.760000000077 / 11202.250000000082 [+0.22%]
Windows-64-VC14:
OCCT
Total CPU difference: 18704.34375 / 18712.96875 [-0.05%]
Products
Total CPU difference: 13043.15625 / 13084.109375 [-0.31%]
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]
Branch [archived branch] has been deleted by Participant.
[revision removed]
[revision removed]
Related records