Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate error messages documentation from enum #33

Open
adamconnelly opened this issue Sep 16, 2020 · 0 comments
Open

Generate error messages documentation from enum #33

adamconnelly opened this issue Sep 16, 2020 · 0 comments

Comments

@adamconnelly
Copy link
Owner

At the moment there's a bit of duplicated effort between the CompilerMessageId enum and the Compiler Messages documentation. We could probably write a simple tool to extract the doc-comments from the enum, and generate a markdown page based on it.

Here's an example of what one of the enum members looks like currently:

/// <summary>
/// The `slist` type is deprecated, and should no-longer be used. Please use the `string`
/// type instead. For example:
/// ```
/// struct User {
///   slist Username
/// }
/// ```
/// </summary>
SlistDeprecated = 204,

There might be a simpler way to do this, but we can definitely use Roslyn to parse the file and grab the comments out, so it shouldn't be difficult to do. Alternatively maybe we ought to just investigate hosting the API docs for the C# code somewhere as a class reference and linking to the enum.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant