On 20/05/2025 14:38, Gregory Casamento wrote:
Andreas,
On Mon, May 19, 2025 at 5:08 PM Andreas Fink <[email protected]> wrote:
The Apple automatic documentation production using DocC
(https://www.swift.org/documentation/docc/) sounded very neat
for that in my eyes but I have no clue if this could be
easily be applied into GNUStep. But that approach would bind
the code to the documentation and would tremendously help to
keep the documentation up to date.
GNUstep has been using that approach of generating docs from sourcecode
for the last twenty years, so the API documentation is almost never out
of date. IMO it's generally better than that of most software projects;
it still contains automatically generated stubs for methods that nobody
has documented properly, but not as many as for most free software. One
possible modern way to fix that would be to use AI - ask ChatGPT to
provide descriptions for methods that lack it, and to provide missing
class overviews, check that it doesn't give bad information, and paste
that into the source code.
What gets dated easily is more things like installation guides, tutorial
content, man pages for tools etc, where the prtoblem is that stuff is
written by different peoiple in different places and we lack the
manpower to pull it together and to periodically review/update it.
