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
I posted kubernetes-sigs/gateway-api#173 to generate documentation for service-apis, and I noticed that no documentation is generated for constants of an aliased type.
For example, in the CRD definition, we have:
// GatewayConditionType is a type of condition associated with a Gateway.typeGatewayConditionTypestringconst (
// ConditionNoSuchGatewayClass indicates that the specified GatewayClass// does not exist.ConditionNoSuchGatewayClassGatewayConditionType="NoSuchGatewayClass"// ConditionGatewayNotScheduled indicates that the Gateway has not been// scheduled.ConditionGatewayNotScheduledGatewayConditionType="GatewayNotScheduled"// ConditionListenersNotReady indicates that at least one of the specified// listeners is not ready. If this condition has a status of True, a more// detailed ListenerCondition should be present in the corresponding// ListenerStatus....
)
Documentation is generated for GatewayConditionType, but not for any of the constants that are defined for this type.
<h3id="networking.x-k8s.io/v1alpha1.GatewayClassConditionType">GatewayClassConditionType
(<code>string</code> alias)</p></h3><p>
(<em>Appears on:</em><ahref="#networking.x-k8s.io/v1alpha1.GatewayClassCondition">GatewayClassCondition</a>)
</p><p><p>GatewayClassConditionType is the type of status conditions.</p></p><h3id="networking.x-k8s.io/v1alpha1.GatewayClassSpec">GatewayClassSpec
</h3>
At least in the way this particular API is written, the doc comments for specific condition types contain information that is useful for API consumers and implementers, so it would be great if these cold be emitted too.
The text was updated successfully, but these errors were encountered:
jpeach
changed the title
Emit documentation for type alias constants
Emit documentation for typed constants
Jun 10, 2020
I posted kubernetes-sigs/gateway-api#173 to generate documentation for service-apis, and I noticed that no documentation is generated for constants of an aliased type.
For example, in the CRD definition, we have:
Documentation is generated for
GatewayConditionType
, but not for any of the constants that are defined for this type.At least in the way this particular API is written, the doc comments for specific condition types contain information that is useful for API consumers and implementers, so it would be great if these cold be emitted too.
The text was updated successfully, but these errors were encountered: