search

orchidhq / Orchid

Build and deploy beautiful documentation sites that grow with you
https://orchid.run
GNU General Public License v3.0
512 stars 53 forks source link

Fix classes with missing/incorrect descriptions #404

Open cjbrooks12 opened 3 years ago

cjbrooks12 commented 3 years ago

There are a handful of classes that do not properly document themselves, or document themselves incorrectly. Orchid needs to be updated so that all common extension classes contain an @Description annotation on the class and all of its @Option properties, and that all of those descriptions are correct.

andyslucky commented 1 year ago

I think another related issue is availability / comprehensive documentation for those that would like to use and extend orchid. I found very little help or documentation while working on a plugin for work.