yade-dev team mailing list archive

[Jan Stránský <honzik.stransky@xxxxxxxxx>]

Hi all,

I added the documentation of inherited members in the last commit. If
anybody doesn't like it, feel free to return it to previous state.
Jsn


2012/7/31 Jan Stránský <honzik.stransky@xxxxxxxxx>

> Hi all,
>
> would you agree with documentation of inherited members in Yade classes?
> For instance, HarmonicRotationEngine has relatively long "family tree" and
> has documented only "A", "f" and "fi" members. "zeroPoint", "rotationAxis"
> and other parameters are in RotationEngine, "ids" in PartialEngine ...
> Similar situation is with materials and many other cases. It is ok for
> skiiled users, but for new people it could be confusing.
>
> What I propose is to document all (including inherited) members, so when
> reading documentation one does not need to jump from one class to another
> just to check if there are some other parameters he/she should know about.
>
> Please send your opinion, if there is agreement, I will try to do it
> Thanks
> Jan
>