search

silverstripe / api.silverstripe.org

API documentation for the Silverstripe Framework
BSD 3-Clause "New" or "Revised" License
3 stars 14 forks source link

Include private statics #74

Closed chillu closed 6 years ago

chillu commented 6 years ago

We use it to document our config, so not mentioning these in API docs is very limiting. Example: http://api.silverstripe.org/4/SilverStripe/Assets/File.html doesn't contain allowed_extensions.

tractorcow commented 6 years ago

Instead of this I suggest to rename to include private marked as @config. Having a section of docs describing the config api for each field is a lot more context-rich than simply including private vars.

chillu commented 6 years ago

If this brings the task from 30 mins to multiple hours, I'm fine with including all private vars as a first step.