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

Base: Clean documentation for PyObjectBase.h.

Browse Source
This commit is contained in:
tritao
2025-02-07 20:21:48 +00:00
parent 2225e7c32f
commit 5117c82d33
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/Base/PyObjectBase.h
View File

@@ -163,18 +163,18 @@ namespace Base
{
/** The PyObjectBase class, exports the class as a python type
/** The PyObjectBase class, exports the class as a Python type
* PyObjectBase is the base class for all C++ classes which
* need to get exported into the python namespace. This class is
* need to get exported into the Python namespace. This class is
* very important because nearly all important classes in FreeCAD
* are visible in python for macro recording and automation purpose.
* The class App::Document is a good expample for an exported class.
* are visible in Python for macro recording and automation purpose.
* The class App::Document is a good example for an exported class.
* There are some convenience macros to make it easier to inherit
* from this class and defining new methods exported to python.
* from this class and defining new methods exported to Python.
* PYFUNCDEF_D defines a new exported method.
* PYFUNCIMP_D defines the implementation of the new exported method.
* In the implementation you can use Py_Return, Py_Error, Py_Try and Py_Assert.
* PYMETHODEDEF makes the entry in the python method table.
* PYMETHODEDEF makes the entry in the Python method table.
* @see Document
* @see PYFUNCDEF_D
* @see PYFUNCIMP_D