You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
The problem is that generated API reference currently shows no information about the default value of a property/field.
By default I mean the value set using inline initializers. I'm not interested in the bodies of constructors being parsed.
Describe the solution you'd like
I'd like for that information to appear in docs. It could be put in the code block mirroring the property/field declaration (Example 1) or as a subsection of the "Property Value"/"Field Value" entries (Example 2).
Describe alternatives you've considered
Putting the default value in a custom description in tag <value> tag (Example 3).
Unfortunately, such a duplication makes desynchronization between the code and the documentation very likely to occur.
Is your feature request related to a problem? Please describe.
The problem is that generated API reference currently shows no information about the default value of a property/field.
By default I mean the value set using inline initializers. I'm not interested in the bodies of constructors being parsed.
Example 0
For the following code:
the generated content looks like this:
Fields
TEST
Field Value
string
Properties
TEST2
Property Value
string
Describe the solution you'd like
I'd like for that information to appear in docs. It could be put in the code block mirroring the property/field declaration (Example 1) or as a subsection of the "Property Value"/"Field Value" entries (Example 2).
Example 1
For the following code:
the generated content could look like this:
Fields
TEST
Field Value
string
Properties
TEST2
Property Value
string
Example 2
For the following code:
the generated content could look like this:
Fields
TEST
Field Value
string
Default Value
"test field"
Properties
TEST2
Property Value
string
Default Value
"test property"
Describe alternatives you've considered
Putting the default value in a custom description in tag
<value>
tag (Example 3).Unfortunately, such a duplication makes desynchronization between the code and the documentation very likely to occur.
Example 3
For the following code:
the generated content could look like this:
Fields
TEST
Field Value
string
Properties
TEST2
Property Value
string
The text was updated successfully, but these errors were encountered: