Feat: Adding a Description for Each Typescript Class and Function

[Sma1lboy]

• I've noticed that there are still a lot of classes and functions that don't have any description in the Obsidian API documentation. As a result, sometimes I have to keep tracing the source code to figure it out.
  • Is there any chance we can add more descriptions.
• I also noticed that some functions may be obsolete or removed. We can do a history trace for each function. Generate a new version of the API documentation on top of the project. I have a cool idea.

[joethei]

We are working on adding more documentation, but it's not a fast process.

I don't fully understand what you mean with the obsolete/removed functions, can you explain more?

[Sma1lboy]

Sorry for the typo mistake. I mean outdated or deprecated APIs. Maybe in the future. Some functions might replacement by similar functions but still keep in the source code.

So I think It might be a good idea if we trying to adding a history in API docs.

A example is Node's API document

I can do this if you think it is worth to do.

[Sma1lboy]

BTW, Can I make PR for adding more documentation on API docs?

[lishid]

Might be worth exploring but I would not recommend attempting to make a PR since our typescript file is generated from code and your changes will just get wiped out on the next run of the generator.