On 10.11.21 00:29, andy pugh wrote:
On Tue, 9 Nov 2021 at 23:19, Steffen Möller <[email protected]> wrote:
Maybe Andy could outline how his system
differs from what po4a would come up with.
The thing I was trying to address is that the HAL components that are
derived from .comp files are self-documenting.
You know better than me if adapting what po4a is doing the .comp files
has any advantages. I like what you have done.
So this source file:
https://github.com/LinuxCNC/linuxcnc/blob/master/src/hal/components/abs.comp
Creates this manpage:
http://linuxcnc.org/docs/2.8/html/man/man9/abs.9.html
Looks good. Since you have this dense integration of documentation and
source - with it is possible to add a link to the generated
documentation that points to the file on github from which it was
generated - but is everyone as exited about that prospect as I am? This
way a larger audience would be introduced to the source code and the
last ambiguities about what the function is doing would go away.
Sidenote - this "provenance" (have every piece of data explain how it
was generated) may be of interest to add to all parts of the documentation.
Best,
Steffen
_______________________________________________
Emc-developers mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/emc-developers
