kindred/create
1
1
Fork 0
Code Issues 53 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Add Missing API documentation/Update API Documentation for various files. (#13062)

Browse Source 
* Added-API-Documentation-for-RectangularTrimmedSurfacePy.xml

* Added-API-Documentation-for-PlateSurfacePy.xml

* Added-API-Documentation-for-ShapeFix.xml

* Added-Back-Missing-Docs

* Add Missing Documentation to BuildPlateSurface

* Elaborate ComplexGeoData Functions

* Elaborate ComplexGeoData Functions

* Elaborates TypePy

* Add Missing Documentation to AreaPy
This commit is contained in:
Anurag Singh
2024-03-22 20:19:36 +05:30
committed by GitHub
parent 426c35051f
commit 8a30854380
4 changed files with 25 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/App/ComplexGeoDataPy.xml
View File

@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
Father="PersistencePy"
Name="ComplexGeoDataPy"
Twin="ComplexGeoData"
Include="App/ComplexGeoData.h"
<PythonExport
Father="PersistencePy"
Name="ComplexGeoDataPy"
Twin="ComplexGeoData"
Include="App/ComplexGeoData.h"
TwinPointer="ComplexGeoData"
Namespace="Data"
FatherInclude="Base/PersistencePy.h"
Namespace="Data"
FatherInclude="Base/PersistencePy.h"
FatherNamespace="Base"
Reference="true">
<Documentation>
@@ -16,7 +16,7 @@
</Documentation>
<Methode Name="getElementTypes" Const="true">
<Documentation>
<UserDocu>Return a list of element types</UserDocu>
<UserDocu>Return a list of element types present in the complex geometric data</UserDocu>
</Documentation>
</Methode>
<Methode Name="countSubElements" Const="true">
@@ -66,7 +66,7 @@
</Methode>
<Attribute Name="BoundBox" ReadOnly="true">
<Documentation>
<UserDocu>Get the BoundBox of the object</UserDocu>
<UserDocu>Get the bounding box (BoundBox) of the complex geometric data.</UserDocu>
</Documentation>
<Parameter Name="BoundBox" Type="Object" />
</Attribute>

7
src/Base/TypePy.xml
View File

@@ -17,12 +17,9 @@ namespace Base {
<Documentation>
<Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
<DeveloperDocu>This is the Type class</DeveloperDocu>
<UserDocu>Base.BaseType class.
<UserDocu>BaseTypePy class.
This class is not intended to create instances of itself, but to get information
from the different types and create instances of them.
Regarding instantiation, this is possible in cases that inherit from the
Base::BaseClass class and are not abstract classes.</UserDocu>
This class provides functionality related to type management in the Base module. It's not intended for direct instantiation but for accessing type information and creating instances of various types. Instantiation is possible for classes that inherit from the Base::BaseClass class and are not abstract.</UserDocu>
</Documentation>
<Methode Name="fromName" Static="true">
<Documentation>

22
src/Mod/CAM/App/AreaPy.xml
View File

@@ -49,52 +49,52 @@ same algorithm</UserDocu>
</Methode>
<Methode Name="makeOffset" Keyword='true'>
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Make an offset of the shape.</UserDocu>
</Documentation>
</Methode>
<Methode Name="makePocket" Keyword='true'>
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Generate pocket toolpath of the shape.</UserDocu>
</Documentation>
</Methode>
<Methode Name="makeSections" Keyword="true">
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Make a list of area holding the sectioned children shapes on given heights.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getClearedArea">
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Gets the area cleared when a tool of the specified diameter follows the gcode represented in the path, ignoring cleared space above zmax and path segments that don't affect space within the x/y space of bbox.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getRestArea">
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Rest machining: Gets the area left to be machined, assuming some of this area has already been cleared by previous tool paths.</UserDocu>
</Documentation>
</Methode>
<Methode Name="toTopoShape">
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Convert the Area object to a TopoShape.</UserDocu>
</Documentation>
</Methode>
<Methode Name="setParams" Keyword="true">
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Set algorithm parameters.</UserDocu>
</Documentation>
</Methode>
<Methode Name="setDefaultParams" Keyword="true">
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Static method to set the default parameters of all following Path.Area, plus the following additional parameters.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getDefaultParams">
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Static method to return the current default parameters.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getParamsDesc" Keyword="true">
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Returns a list of supported parameters and their descriptions.</UserDocu>
</Documentation>
</Methode>
<Methode Name="getParams">
@@ -104,7 +104,7 @@ same algorithm</UserDocu>
</Methode>
<Methode Name="abort" Keyword="true">
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Abort the current operation.</UserDocu>
</Documentation>
</Methode>
<Attribute Name="Sections" ReadOnly="true">

6
src/Mod/Part/App/GeomPlate/BuildPlateSurfacePy.xml
View File

@@ -23,7 +23,7 @@
</Methode>
<Methode Name="setNbBounds">
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Sets the number of bounds</UserDocu>
</Documentation>
</Methode>
<Methode Name="loadInitSurface">
@@ -85,12 +85,12 @@
</Methode>
<Methode Name="disc2dContour">
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Returns the 2D contour of the plate surface</UserDocu>
</Documentation>
</Methode>
<Methode Name="disc3dContour">
<Documentation>
<UserDocu></UserDocu>
<UserDocu>Returns the 3D contour of the plate surface</UserDocu>
</Documentation>
</Methode>
<Methode Name="G0Error" Const="true">