Improve docstrings for language types

2025-12-30 03:00:13 +08:00 · 2025-08-05 17:49:01 +01:00
parent bf692c08e7
commit fa18cc9db4
3 changed files with 14 additions and 7 deletions
--- a/src/languages.ts
+++ b/src/languages.ts
@@ -1,11 +1,12 @@
-/**
- * A CodeQL language.
- *
- * To facilitate adding new languages, this is a typedef rather than an
- * exhaustive list of languages supported by CodeQL.
- */
+/** A language supported by CodeQL. */
 export type Language = string;

+/**
+ * A language supported by CodeQL that is treated specially by the Action.
+ *
+ * This is not an exhaustive list of languages supported by CodeQL and new
+ * languages do not need to be added here.
+ */
 export enum KnownLanguage {
  csharp = "csharp",
  cpp = "cpp",