A flowchart paranoid (a story about source code documentation)

  • abu
  • abu's Avatar Topic Author
  • Offline
  • Senior Member
  • Senior Member
More
22 Nov 2025 05:03 #338950 by abu
Hello everyone.

I've always been very curious about how LinuxCNC code works, and I participated in translating the documentation into Spanish when it was at version 2.8. Now I'm looking for opinions in a forum about a need some of us might have (I suppose): documentation of the source code itself.

I love images. A flowchart is a treasure for me. Yes, I know: code is the best documentation... but sometimes it's a real headache (we all know that, right?).

That said, let's get down to business!

I've prepared the PDF attached to this post. First of all, apologies: some of it is in Spanish (mainly the descriptions), but that doesn't obscure the general idea.

The document relates to the halcmd_completion.c file and is just an example. It only took me half a day to prepare, and the flowcharts haven't been proofread. I insist: I'm asking for your opinions on my vision, not for technical corrections.

This isn't the time to discuss the file itself, but rather to share my idea for documentation. I believe any "novice LinuxCNC coder" can find guidance with this type of "document".

I'm also aware that this is a user forum, not a developer meeting place, but... what about "high-end" users?  

This browser does not support PDFs. Please download the PDF to view it: Download PDF



Thanks in advance for your comments.
J.M. Garcia a.k.a. Abu
Attachments:
The following user(s) said Thank You: tommylight

Please Log in or Create an account to join the conversation.

Moderators: HansU
Time to create page: 0.046 seconds
Powered by Kunena Forum