Document LinuxCNC Boost.Python shim source basis

core/wasm_shims/boost/python/class.hpp

@@ -1,5 +1,7 @@
 #pragma once
 
+// LinuxCNC source basis: interpmodule.cc, pyblock.cc, pyemctypes.cc, and
+// array1.hh include boost/python/class.hpp for Python binding classes.
 #include <boost/call_traits.hpp>
 #include <boost/config.hpp>
 

core/wasm_shims/boost/python/converter/registry.hpp

@@ -1,3 +1,5 @@
 #pragma once
 
+// LinuxCNC source basis: array1.hh includes boost/python/converter/registry.hpp
+// for registered class object lookup.
 #include "boost/python/object.hpp"

core/wasm_shims/boost/python/def.hpp

@@ -1,5 +1,7 @@
 #pragma once
 
+// LinuxCNC source basis: canonmodule.cc and interpmodule.cc include
+// boost/python/def.hpp for Boost.Python module functions.
 #include "boost/python/object.hpp"
 
 namespace boost {

core/wasm_shims/boost/python/detail/caller.hpp

@@ -1,3 +1,5 @@
 #pragma once
 
+// LinuxCNC source basis: pyarrays.cc includes boost/python/detail/caller.hpp
+// for return_internal_reference support.
 #include "boost/python/object.hpp"

core/wasm_shims/boost/python/enum.hpp

@@ -1,5 +1,7 @@
 #pragma once
 
+// LinuxCNC source basis: canonmodule.cc, boost_pyenum_macros.hh, and array1.hh
+// use boost::python::enum_ for Python enum bindings.
 #include "boost/python/object.hpp"
 
 namespace boost {

core/wasm_shims/boost/python/exception_translator.hpp

@@ -1,5 +1,7 @@
 #pragma once
 
+// LinuxCNC source basis: interpmodule.cc uses
+// boost::python::register_exception_translator.
 #include "boost/python/object.hpp"
 
 namespace boost {

core/wasm_shims/boost/python/module.hpp

@@ -1,5 +1,7 @@
 #pragma once
 
+// LinuxCNC source basis: canonmodule.cc and interpmodule.cc use
+// BOOST_PYTHON_MODULE for embedded Python module declarations.
 #include "boost/python/object.hpp"
 
 #define BOOST_PYTHON_MODULE(name) extern "C" void init_##name()

core/wasm_shims/boost/python/object/class_detail.hpp

@@ -1,5 +1,7 @@
 #pragma once
 
+// LinuxCNC source basis: array1.hh includes boost/python/object/class_detail.hpp
+// for registered_class_object().
 #include "boost/python/object.hpp"
 
 namespace boost {

core/wasm_shims/boost/python/object_fwd.hpp

@@ -1,5 +1,7 @@
 #pragma once
 
+// LinuxCNC source basis: interp_internal.hh forward-declares Boost.Python
+// object pointers through boost/python/object_fwd.hpp.
 namespace boost {
 namespace python {
 
@@ -7,4 +9,3 @@ class object;
 
 } // namespace python
 } // namespace boost
-

core/wasm_shims/boost/python/return_internal_reference.hpp

@@ -1,5 +1,7 @@
 #pragma once
 
+// LinuxCNC source basis: pyarrays.cc uses boost::python::return_internal_reference
+// for array wrapper bindings.
 #include "boost/python/object.hpp"
 
 namespace boost {

core/wasm_shims/boost/python/suite/indexing/map_indexing_suite.hpp

@@ -1,5 +1,7 @@
 #pragma once
 
+// LinuxCNC source basis: interpmodule.cc, pyblock.cc, pyparamclass.cc, and
+// pyinterp1.cc include map_indexing_suite for Boost.Python map wrappers.
 namespace boost {
 namespace python {