diff --git a/Doc/dev-notes/modify-formfactor.md b/Doc/dev-notes/modify-formfactor.md new file mode 100644 index 0000000000000000000000000000000000000000..9700b67726a2fe4dc41385cd052e14b7fa0a2f0c --- /dev/null +++ b/Doc/dev-notes/modify-formfactor.md @@ -0,0 +1,16 @@ +#### How to make an API change that involves a form factor + +This note shall help when you +* add a form factor +* remove a form factor +* change a form factor's argument list + +After adding or removing a form factor, the following files need to be updated: +* Core/Basics/BornAgainNamespace.h +* Core/Parametrization/INodeVisitor.h (in two places) +* Core/includeIncludes/HardParticles.h +* Wrap/swig/libBornAgainCore.i (in two places: #include and %include) + +If the form factor is supported by the GUI, then also: +* GUI/coregui/Models/GUIDomainSampleVisitor.h +* GUI/coregui/Models/GUIDomainSampleVisitor.cpp