Code Quality: Document entire repository

[Lamparter]

Similar to #15652, I've taken the time to document the entire repository.
However, unlike the previous PR, this is far less descriptive codebase documentation and so is far less likely to become outdated.

To be honest, I wonder whether this might be more viable:

I guess we should xml comments and generate api docs from it (I know there's a tool for it).

That might be a good idea, but it's down to @yaira2 to express his plans for documentation.

[Jay-o-Way]

Gotta appreciate the effort. Just a nit: I read that it's unnecessary c.q. unrecommended to mix headers and formatting.

[Lamparter]

unrecommended to mix headers and formatting.

@Jay-o-Way what do you mean?

[Jay-o-Way]

I mean using # and code formatting. Generally headers are best kept as clean as possible :)

# `text`

(same counts for e.g. links, which is not in this pr)

[Lamparter]

Ah yes. I just used it to specify the directory.

[0x5bfa]

So just let you know, I disagree with this idea. No one sees Strings dir, for example. Files codebase follows a normal MVVM design pattern, anyone can understand what's in these folders. Just the source is complicated, not the structure.

[Lamparter]

Maybe that's correct.

[yaira2]

Let's discuss this proposal in #16364

[0x5bfa]

@yaira2 @Lamparter i think we can close this for now, we haven't made a solid decision how to document the source code.