qingfengxia / freecad_mod_dev_guide Goto Github PK

JFYI, There is a proposal for revamping CMake:
FreeCAD/FreeCAD#2477

relevant:
https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide/blob/master/chapters/2.FreeCAD_source_code_structure.md

https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide/blob/master/chapters/A2.cmake_cheatsheet.md

Documentation:

• https://www.freecadweb.org/wiki/Scenegraph

Examples:

• Camera motion in Linux absent
• Question: is there a way to magnify a point or node when the crosshair is in it's vicinity
• Civil engineering feature implementation (Transportation Engineering)

https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide/blob/master/chapters/9.FreeCAD%20Module%20testing%20and%20debugging.md

• @bblacey shares"Developers - if you want must FASTER local builds, install GNU ccache" thread
• https://www.virag.si/2015/07/use-ccache-with-cmake-for-faster-compilation/

Thanks to the work of user vocx in the FC wiki there is a lot of updated info on how to write documentation using Doxygen.

FreeCAD Wiki Doxygen documentation: https://www.freecadweb.org/wiki/Doxygen

https://forum.freecadweb.org/viewtopic.php?f=10&t=35383
https://www.youtube.com/watch?v=P0pIW5tJrRM

Something about how to setup the following environments for FC development:

• QtCreator for Linux/OSX/Windows
• KDevelop
• Atom
• PyCharm
• Eclipse
• Vim/NeoVIM
• Docker
  Etc...

is there any tool, search and match code snippet/excerpt to the latest source code file?

something like
[[anchor text, do not change, 1]]

https://forum.freecadweb.org/viewtopic.php?f=42&t=36818

this should be added into this book

Ref: https://forum.freecadweb.org/viewtopic.php?f=18&t=35428

Regarding this chapter: https://github.com/qingfengxia/FreeCAD_Mod_Dev_Guide/blob/master/chapters/3.FreeCAD_Base_App_modules.md#type-baseclass-pyobjectbase

Instead of listing the code, it would be more useful to document the purpose of the type system and how it's being used.

See my investigation here:
FreeCAD/FreeCAD#3802 (comment)

I think the main reason for this is serialization and code inspection. So that document object instances can be created from strings stored in a FCStd file, and object instances be inspected in a Python console. And more importantly, to decouple C++ implementation from the UI appearance (Property and type names in a view toolbar).

I don't think it has anything to do with reference counting, outside the PyObject exports, does it?

A more practical use case is the TypeId and addObject implementation. Using addObject from Python you can create instances of C++ classes and map them to the Python type system.

As most of workbenches are developed in Python nowadays, there should be some recommendation on how to identify object types. E.g.:

You may use TypeId if you want to use document object properties
You must use isinstance to determine that the object has a particular method, as TypeId can be re-implemented by a different class

all third-party module can be inserted into freecad package

from pkgutil import extend_path

see example in Plot module, init

it will affect Mod folder structure

Sourcetrail can also be one of the tools to help in this effort
https://forum.freecadweb.org/viewtopic.php?f=10&t=37386
https://www.sourcetrail.com/