The help and development forum of FreeCAD
https://forum.freecad.org/
could you explain a bit more what do mean?Kunda1 wrote:I listed FEM files that could use a peak at their documentation (list created from a regex) to meet the standards mentioned in the thread.
Not all the files in the src/Mod/FEM/ are listed in my post. There are some files that start with an underscore that I didn't include.bernd wrote:could you explain a bit more what do mean?Kunda1 wrote:I listed FEM files that could use a peak at their documentation (list created from a regex) to meet the standards mentioned in the thread.
Code: Select all
__Comment__ = 'Imports and scales an Airfoil in the form of a Draft Wire (DWire) or Basic Spline (BSpline)'
__Web__ = 'http://forum.freecadweb.org/viewtopic.php?f=22&t=5554'
__Wiki__ = "http://www.freecadweb.org/wiki/index.php?title=Macro_Airfoil_Import_%26_Scale'
__Icon__ = '/usr/lib/freecad/Mod/plugins/icons/airfoil.png'
__Help__ = 'Start the macro and follow the instructions'
__Author__ = 'quick61'
__Version__ = '2.1'
__Status__ = 'stable'
__Requires__ = 'freecad 0.14.3706'
__Communication__ = 'your email adress or yourgit or something else'
There is no need to add it to all python files.Pardon, I misunderstood. nevertheless there are still doxygen comments that could be added in order to generate doxygen docs for FEMPrzemoF wrote:That applies to macros only, unless I'm missing something?
exactly !PrzemoF wrote:That applies to macros only ...
Could you give more informations?Kunda1 wrote:...nevertheless there are still doxygen comments that could be added in order to generate doxygen docs for FEM
Code: Select all
S> ## Sets mesh color using selected type of results (Sabs by default)
# @param self The python object self
# @param result_type Type of FEM result, allowed are:
# - U1, U2, U3 - deformation
# - Uabs - absolute deformation
# - Sabs - Von Mises stress
# @param limit cutoff value. All values over the limit are treated as equal to the limit. Useful for filtering out hot spots.
def show_result(self, result_type="Sabs", limit=None):
Please check the doxygen tweeks i've made in https://github.com/luzpaz/FreeCAD/tree/ ... gen-tweeksbernd wrote:Could you give more informations?Kunda1 wrote:...nevertheless there are still doxygen comments that could be added in order to generate doxygen docs for FEM