OpenAPI Emitter: `@example` doc tag should compile to `example` field

[mcchrish]

Clear and concise description of the problem

/**
 * Uniform Resource Name
 * @example urn:xx:service::foobar/d9aadcde-a4b3-4fba-9f20-c5bd2fdb5071
 */
scalar URN extends string;

Should compile to

    URN:
      type: string
      description: Uniform Resource Name
      example: urn:xx:service::foobar/d9aadcde-a4b3-4fba-9f20-c5bd2fdb5071

Checklist

• Follow our Code of Conduct
• Read the docs.
• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

[sarangan12]

The @example tag should not be used in the way it is mentioned in the issue description. It should be used as:

/**
 * Uniform Resource Name
 * Dummy Comments.
 */
@example("urn:xx:service::foobar/d9aadcde-a4b3-4fba-9f20-c5bd2fdb5071")
scalar URN extends string;

This is working fine. Here is the Playground link

I believe the we are getting the expected results and the issue can be resolved. @timotheeguerin Any comments?

[timotheeguerin]

Yeah the issue is about being able to use the @example tag from the doc comment. But this require some design or at least some investigation if we actually can make it work