-
Notifications
You must be signed in to change notification settings - Fork 106
updating cpp documentation for 2.5.0 release #444
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the C++ documentation for the lib3mf library to reflect version 2.5.0. The update includes adding extensive documentation for new classes and functions introduced in this release, correcting a typo in existing documentation, and updating version references throughout.
- Updates version references from v2.3.2 to v2.5.0 in documentation configuration and index files
- Adds comprehensive documentation for new implicit function nodes, level sets, volume data, and 3D image support
- Corrects a spelling error in metadata documentation ("shuold" → "should")
Reviewed changes
Copilot reviewed 95 out of 95 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| Documentation/conf.py | Updated release version from v2.3.2 to v2.5.0 |
| Documentation/index.rst | Updated documentation title and welcome text to reference v2.5.0 |
| AutomaticComponentToolkit/lib3mf.xml | Enabled Sphinx documentation generation for CppDynamic binding |
| Documentation/source/Cpp/lib3mf_VolumeDataProperty.rst | Added documentation for CVolumeDataProperty class |
| Documentation/source/Cpp/lib3mf_VolumeDataComposite.rst | Added documentation for CVolumeDataComposite class |
| Documentation/source/Cpp/lib3mf_VolumeDataColor.rst | Added documentation for CVolumeDataColor class |
| Documentation/source/Cpp/lib3mf_VolumeData.rst | Added documentation for CVolumeData class |
| Documentation/source/Cpp/lib3mf_VectorFromScalarNode.rst | Added documentation for CVectorFromScalarNode class |
| Documentation/source/Cpp/lib3mf_UnsignedMeshNode.rst | Added documentation for CUnsignedMeshNode class |
| Documentation/source/Cpp/lib3mf_TwoInputNode.rst | Added documentation for CTwoInputNode base class |
| Documentation/source/Cpp/lib3mf_TriangleSet.rst | Added documentation for CTriangleSet class |
| Documentation/source/Cpp/lib3mf_TransposeNode.rst | Added documentation for CTransposeNode class |
| Documentation/source/Cpp/lib3mf_Texture2D.rst | Updated parameter type from pointer to classParam |
| Documentation/source/Cpp/lib3mf_TanhNode.rst | Added documentation for CTanhNode class |
| Documentation/source/Cpp/lib3mf_TanNode.rst | Added documentation for CTanNode class |
| Documentation/source/Cpp/lib3mf_SubtractionNode.rst | Added documentation for CSubtractionNode class |
| Documentation/source/Cpp/lib3mf_SqrtNode.rst | Added documentation for CSqrtNode class |
| Documentation/source/Cpp/lib3mf_SliceStack.rst | Updated parameter type from pointer to classParam |
| Documentation/source/Cpp/lib3mf_SinhNode.rst | Added documentation for CSinhNode class |
| Documentation/source/Cpp/lib3mf_SinNode.rst | Added documentation for CSinNode class |
| Documentation/source/Cpp/lib3mf_SignNode.rst | Added documentation for CSignNode class |
| Documentation/source/Cpp/lib3mf_SelectNode.rst | Added documentation for CSelectNode class |
| Documentation/source/Cpp/lib3mf_RoundNode.rst | Added documentation for CRoundNode class |
| Documentation/source/Cpp/lib3mf_ResourceIdNode.rst | Added documentation for CResourceIdNode class |
| Documentation/source/Cpp/lib3mf_ResourceDataGroup.rst | Updated parameter types from pointers to classParam |
| Documentation/source/Cpp/lib3mf_Resource.rst | Updated parameter type from pointer to classParam |
| Documentation/source/Cpp/lib3mf_PowNode.rst | Added documentation for CPowNode class |
| Documentation/source/Cpp/lib3mf_OneInputNode.rst | Added documentation for COneInputNode base class |
| Documentation/source/Cpp/lib3mf_Object.rst | Added IsLevelSetObject method and updated parameter types |
| Documentation/source/Cpp/lib3mf_NormalizeDistanceNode.rst | Added documentation for CNormalizeDistanceNode class |
| Documentation/source/Cpp/lib3mf_NodeIterator.rst | Added documentation for CNodeIterator class |
| Documentation/source/Cpp/lib3mf_MultiplicationNode.rst | Added documentation for CMultiplicationNode class |
| Documentation/source/Cpp/lib3mf_Model.rst | Added multiple new methods for functions, level sets, and image stacks |
| Documentation/source/Cpp/lib3mf_ModNode.rst | Added documentation for CModNode class |
| Documentation/source/Cpp/lib3mf_MinNode.rst | Added documentation for CMinNode class |
| Documentation/source/Cpp/lib3mf_MetaDataGroup.rst | Corrected spelling of "should" in parameter description |
| Documentation/source/Cpp/lib3mf_MeshObject.rst | Added methods for VolumeData and TriangleSet management |
| Documentation/source/Cpp/lib3mf_MeshNode.rst | Added documentation for CMeshNode class |
| Documentation/source/Cpp/lib3mf_MaxNode.rst | Added documentation for CMaxNode class |
| Documentation/source/Cpp/lib3mf_MatrixFromRowsNode.rst | Added documentation for CMatrixFromRowsNode class |
| Documentation/source/Cpp/lib3mf_MatrixFromColumnsNode.rst | Added documentation for CMatrixFromColumnsNode class |
| Documentation/source/Cpp/lib3mf_MaterialMapping.rst | Added documentation for CMaterialMapping class |
| Documentation/source/Cpp/lib3mf_MatVecMultiplicationNode.rst | Added documentation for CMatVecMultiplicationNode class |
| Documentation/source/Cpp/lib3mf_LogNode.rst | Added documentation for CLogNode class |
| Documentation/source/Cpp/lib3mf_Log2Node.rst | Added documentation for CLog2Node class |
| Documentation/source/Cpp/lib3mf_Log10Node.rst | Added documentation for CLog10Node class |
| Documentation/source/Cpp/lib3mf_LevelSetIterator.rst | Added documentation for CLevelSetIterator class |
| Documentation/source/Cpp/lib3mf_LevelSet.rst | Added documentation for CLevelSet class |
| Documentation/source/Cpp/lib3mf_LengthNode.rst | Added documentation for CLengthNode class |
| Documentation/source/Cpp/lib3mf_KeyStore.rst | Updated parameter types from pointers to classParam |
| Documentation/source/Cpp/lib3mf_Iterator.rst | Added documentation for CIterator base class |
| Documentation/source/Cpp/lib3mf_InverseNode.rst | Added documentation for CInverseNode class |
| Documentation/source/Cpp/lib3mf_ImplicitPortIterator.rst | Added documentation for CImplicitPortIterator class |
| Documentation/source/Cpp/lib3mf_ImplicitPort.rst | Added documentation for CImplicitPort class |
| Documentation/source/Cpp/lib3mf_ImplicitNode.rst | Added documentation for CImplicitNode class |
| Documentation/source/Cpp/lib3mf_ImplicitFunction.rst | Added extensive documentation for CImplicitFunction class |
| Documentation/source/Cpp/lib3mf_ImageStack.rst | Added documentation for CImageStack class |
| Documentation/source/Cpp/lib3mf_Image3DIterator.rst | Added documentation for CImage3DIterator class |
| Documentation/source/Cpp/lib3mf_Image3D.rst | Added documentation for CImage3D class |
| Documentation/source/Cpp/lib3mf_FunctionReference.rst | Added documentation for CFunctionReference class |
| Documentation/source/Cpp/lib3mf_FunctionIterator.rst | Added documentation for CFunctionIterator class |
| Documentation/source/Cpp/lib3mf_FunctionGradientNode.rst | Added documentation for CFunctionGradientNode class |
| Documentation/source/Cpp/lib3mf_FunctionFromImage3D.rst | Added documentation for CFunctionFromImage3D class |
| Documentation/source/Cpp/lib3mf_FunctionCallNode.rst | Added documentation for CFunctionCallNode class |
| Documentation/source/Cpp/lib3mf_Function.rst | Added documentation for CFunction class |
| Documentation/source/Cpp/lib3mf_FractNode.rst | Added documentation for CFractNode class |
| Documentation/source/Cpp/lib3mf_FmodNode.rst | Added documentation for CFmodNode class |
| Documentation/source/Cpp/lib3mf_FloorNode.rst | Added documentation for CFloorNode class |
| Documentation/source/Cpp/lib3mf_ExpNode.rst | Added documentation for CExpNode class |
| Documentation/source/Cpp/lib3mf_DotNode.rst | Added documentation for CDotNode class |
| Documentation/source/Cpp/lib3mf_DivisionNode.rst | Added documentation for CDivisionNode class |
| Documentation/source/Cpp/lib3mf_DecomposeVectorNode.rst | Added documentation for CDecomposeVectorNode class |
| Documentation/source/Cpp/lib3mf_CrossNode.rst | Added documentation for CCrossNode class |
| Documentation/source/Cpp/lib3mf_CoshNode.rst | Added documentation for CCoshNode class |
| Documentation/source/Cpp/lib3mf_CosNode.rst | Added documentation for CCosNode class |
| Documentation/source/Cpp/lib3mf_ConstantNode.rst | Added documentation for CConstantNode class |
| Documentation/source/Cpp/lib3mf_ConstVecNode.rst | Added documentation for CConstVecNode class |
| Documentation/source/Cpp/lib3mf_ConstMatNode.rst | Added documentation for CConstMatNode class |
| Documentation/source/Cpp/lib3mf_ComposeVectorNode.rst | Added documentation for CComposeVectorNode class |
| Documentation/source/Cpp/lib3mf_ComposeMatrixNode.rst | Added documentation for CComposeMatrixNode class |
| Documentation/source/Cpp/lib3mf_ComponentsObject.rst | Updated parameter type from pointer to classParam |
| Documentation/source/Cpp/lib3mf_ClampNode.rst | Added documentation for CClampNode class |
| Documentation/source/Cpp/lib3mf_CeilNode.rst | Added documentation for CCeilNode class |
| Documentation/source/Cpp/lib3mf_BeamLatticeNode.rst | Added documentation for CBeamLatticeNode class |
| Documentation/source/Cpp/lib3mf_BeamLattice.rst | Removed duplicate text in GetBallOptions description |
| Documentation/source/Cpp/lib3mf_Base.rst | Added ClassTypeId method documentation |
| Documentation/source/Cpp/lib3mf_Attachment.rst | Updated ReadFromFile description and added ReadFromCallback method |
| Documentation/source/Cpp/lib3mf_ArcTanNode.rst | Added documentation for CArcTanNode class |
| Documentation/source/Cpp/lib3mf_ArcTan2Node.rst | Added documentation for CArcTan2Node class |
| Documentation/source/Cpp/lib3mf_ArcSinNode.rst | Added documentation for CArcSinNode class |
| Documentation/source/Cpp/lib3mf_ArcCosNode.rst | Added documentation for CArcCosNode class |
| Documentation/source/Cpp/lib3mf_AdditionNode.rst | Added documentation for CAdditionNode class |
| Documentation/source/Cpp/lib3mf_AbsNode.rst | Added documentation for CAbsNode class |
| Documentation/source/Cpp/lib3mf.rst | Updated parameter types and added GetSymbolLookupMethod |
| Documentation/source/Cpp/lib3mf-types.rst | Added new enumerations and structs for implicit functions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
vijaiaeroastro
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see a few spelling mistakes suggested by Copilot.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #444 +/- ##
========================================
Coverage 59.66% 59.66%
========================================
Files 64 64
Lines 24646 24646
========================================
Hits 14705 14705
Misses 9941 9941 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
fixed them in xml and updated the documentation |
3dJan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice improvement
After merging this to the develop branch, this needs to be tested on the readthedocs page