Update typedoc command #11
Conversation
Set typedoc to ignore compiler errors (since it is currently unable to process the 'readonly' attribute).
|
Wow does that work? It still generates documentation? |
|
It works for everything not marked as readonly, and for those things marked as readonly it considers it a property defined multiple times. So it generates some documentation (everything but readonly), which I figured would be better than none. I can show you a picture of what it looks like if you'd like. |
|
AWESOME. Just tried it. Let's just remove our readonly modifiers. |
|
Go ahead and make that change and I'll merge this PR |
|
You want me to remove all the readonly modifiers? |
Temporary measure until typedoc is updated to properly support them.
|
Yeah, it won't break anything. It just means people won't get errors if they try to write to those properties (which is not ideal, but we can use a more verbose pattern of get accessor + private internal property in order to provide run-time safety and still generate working documentation). Hopefully typedoc will get updated soon though... |
|
Just remove the modifiers for now though. |
Update typedoc command and remove readonly modifiers
Set typedoc to ignore compiler errors (since it is currently unable to process the 'readonly' attribute).