JSBSim-Team / jsbsim

An open source flight dynamics & control software library
GNU Lesser General Public License v2.1
1.22k stars 420 forks source link

Documentation updates. #1048

Closed bcoconni closed 2 months ago

bcoconni commented 2 months ago

This PR addresses 2 issues related to documentation:

Regarding the first issue, the problem is due to the lack of Doxygen documentation in src/simgear/props/props.hxx which makes python/Doxy2PyDocStrings.py crash. The problem has been fixed by including the documentation of FGPropertyNode.get_double_value() and FGPropertyNode.get_double_value() directly in python/JSBSim.pyx.in.

In the process, FGPropertyNode.set_double_value() has been fixed to behave like its C++ counterpart (returns a boolean to indicate if the update of the property value has succeeded).

davidmegginson commented 1 month ago

Since all of the other control inputs are normalised between 0.0 and 1.0 (or -1.0 and 1.0), it seems strange that the mixture wouldn't be, but understood why that's necessary to work around an issue in one of the FDMs.