Enforce fixes for missing docs

[Travis Prescott (tjprescott)]

This PR make it so that docs generation fails if anything that should have docs does not. As a result, it will also have a ton of doc fixes.

This also adds ref doc generation for scalars and fixes a logic bug in the generation of docs.

TODO

• decorators
• decorator parameters
• template parameters
• models
• unions
• enums
• interfaces
• operations
• scalars

Example output:

Issues in @typespec/compiler:
Missing documentation for template parameter 'Array.T'.
Missing documentation for template parameter 'Record.T'.
Missing documentation for template parameter 'OptionalProperties.T'.
Missing documentation for template parameter 'UpdateableProperties.T'.
Missing documentation for template parameter 'OmitProperties.T'.
Missing documentation for template parameter 'OmitProperties.TKeys'.
Missing documentation for template parameter 'OmitDefaults.T'.
Missing documentation for template parameter 'DefaultKeyVisibility.T'.
Missing documentation for template parameter 'DefaultKeyVisibility.Visibility'.
Missing documentation for decorator '@withUpdateableProperties'.
Missing documentation for decorator parameter '@withoutOmittedProperties.omit'.
Missing documentation for decorator '@withoutOmittedProperties'.
Missing documentation for decorator '@withoutDefaultValues'.
Missing documentation for decorator parameter '@withDefaultKeyVisibility.visibility'.
Missing documentation for decorator '@withDefaultKeyVisibility'.
Missing documentation for decorator parameter '@friendlyName.formatArgs'.
Missing documentation for decorator parameter '@key.altName'.
Missing documentation for decorator parameter '@discriminator.propertyName'.
Missing documentation for decorator parameter '@visibility.visibilities'.
Missing documentation for decorator parameter '@withVisibility.visibilities'.
Missing documentation for decorator parameter '@inspectType.text'.
Missing documentation for decorator '@inspectType'.
Missing documentation for decorator parameter '@inspectTypeName.text'.
Missing documentation for decorator '@inspectTypeName'.

Issues in @typespec/http:
Missing documentation for template parameter 'ApiKeyAuth.TLocation'.
Missing documentation for template parameter 'ApiKeyAuth.TName'.
Missing documentation for template parameter 'OAuth2Auth.TFlows'.
Missing documentation for decorator parameter '@includeInapplicableMetadataInPayload.value'.
Missing documentation for decorator parameter '@route.options'.

[github-actions]

Changes in this PR will be published to the following url to try(check status of TypeSpec Pull Request Try It pipeline for publish status):
Playground: https://cadlplayground.z22.web.core.windows.net/prs/1860/

Website: https://cadlwebsite.z1.web.core.windows.net/prs/1860/