Implement NaturalDocs commenting to document the project
NaturalDocs (and it's many competitors) provide automatic compilation of HTML documentation of code based upon formatting comments in a particular way that it can interpret. So if we format the code comments to follow NaturalDoc formatting, we can then have an on-hand and much easier to read documentation of the code. This would be a big plus because one of the major flaws of GNU social is a lack of documentation outside of the code itself.
As to why NaturalDocs - no particular reason other than it's the thing that does this that I am familiar with.
Broad completion checklist:
As a result of this change, some of the header information will probably be removed since it will be preserved in the documentation structure when generated and just clutters the actual header (which is already a mile long)
marked the task / as completedToggle commit list
Some big drops the last couple of days related to going through stuff in actions. This is going to be a several day project unless I do it with the kind of crunch that makes me hate coding, so .. yeah, it's a several day project at least. But it's getting there! Most of the API stuff is in there now.
Basic documentation of all the files in the /actions/ folder was completed today in a series of commits.