search

GoogleChrome / chrome-types

Code to parse Chrome's internal extension type definitions—published on NPM as chrome-types
https://www.npmjs.com/package/chrome-types
Apache License 2.0
189 stars 30 forks source link

Wrapping a `$(ref:...)` in <code></code> outputs broken links and style #46

Open rdcronin opened 1 year ago

rdcronin commented 1 year ago

Check out bluetoothSocket.CreateInfo, which is generated from this file. The description in the file is:

    // The ID of the newly created socket. Note that socket IDs created
    // from this API are not compatible with socket IDs created from other APIs,
    // such as the <code>$(ref:sockets.tcp)</code> API.

Wrapping the $(ref:sockets.tcp) in <code> tags results in broken output in the server.

bad_doc_styling

We should either a) remove all instances of tags wrapping $(refs) and add a warning or b) have the output handle it appropriately.

jpmedley commented 1 year ago

@rdcronin Thanks for letting us know.

jpmedley commented 1 year ago

I'm reviving this. For reasons related to a years worth of cleanup and more that's coming, this could start to stand out soon.