Check for missing @param and @return annotations

doc/en-us/config.md

@@ -240,6 +240,7 @@ Array<string>
 * ``"exp-in-action"``
 * ``"global-element"``
 * ``"global-in-nil-env"``
+* ``"incomplete-signature-doc"``
 * ``"index-in-func-name"``
 * ``"invisible"``
 * ``"jump-local-scope"``
@@ -284,6 +285,7 @@ Array<string>
 * ``"miss-sep-in-table"``
 * ``"miss-space-between"``
 * ``"miss-symbol"``
+* ``"missing-global-doc"``
 * ``"missing-parameter"``
 * ``"missing-return"``
 * ``"missing-return-value"``
@@ -449,6 +451,8 @@ object<string, string>
     * duplicate-doc-alias
     * duplicate-doc-field
     * duplicate-doc-param
+    * incomplete-signature-doc
+    * missing-global-doc
     * undefined-doc-class
     * undefined-doc-name
     * undefined-doc-param
@@ -572,6 +576,8 @@ object<string, string>
     * duplicate-doc-alias
     * duplicate-doc-field
     * duplicate-doc-param
+    * incomplete-signature-doc
+    * missing-global-doc
     * undefined-doc-class
     * undefined-doc-name
     * undefined-doc-param
@@ -792,6 +798,10 @@ object<string, string>
     */
     "global-in-nil-env": "Any",
     /*
+    Enable diagnostics for function definitions which are not fully annotated.
+    */
+    "incomplete-signature-doc": "None",
+    /*
     Enable diagnostics for accesses to fields which are invisible.
     */
     "invisible": "Any",
@@ -800,6 +810,10 @@ object<string, string>
     */
     "lowercase-global": "Any",
     /*
+    Enable diagnostics for global function definitions which are not fully annotated.
+    */
+    "missing-global-doc": "None",
+    /*
     Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.
     */
     "missing-parameter": "Any",
@@ -1044,6 +1058,10 @@ object<string, string>
     */
     "global-in-nil-env": "Warning",
     /*
+    Enable diagnostics for function definitions which are not fully annotated.
+    */
+    "incomplete-signature-doc": "Warning",
+    /*
     Enable diagnostics for accesses to fields which are invisible.
     */
     "invisible": "Warning",
@@ -1052,6 +1070,10 @@ object<string, string>
     */
     "lowercase-global": "Information",
     /*
+    Enable diagnostics for global function definitions which are not annotated.
+    */
+    "missing-global-doc": "Warning",
+    /*
     Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.
     */
     "missing-parameter": "Warning",

doc/pt-br/config.md

@@ -240,6 +240,7 @@ Array<string>
 * ``"exp-in-action"``
 * ``"global-element"``
 * ``"global-in-nil-env"``
+* ``"incomplete-signature-doc"``
 * ``"index-in-func-name"``
 * ``"invisible"``
 * ``"jump-local-scope"``
@@ -284,6 +285,7 @@ Array<string>
 * ``"miss-sep-in-table"``
 * ``"miss-space-between"``
 * ``"miss-symbol"``
+* ``"missing-global-doc"``
 * ``"missing-parameter"``
 * ``"missing-return"``
 * ``"missing-return-value"``
@@ -449,6 +451,8 @@ object<string, string>
     * duplicate-doc-alias
     * duplicate-doc-field
     * duplicate-doc-param
+    * incomplete-signature-doc
+    * missing-global-doc
     * undefined-doc-class
     * undefined-doc-name
     * undefined-doc-param
@@ -572,6 +576,7 @@ object<string, string>
     * duplicate-doc-alias
     * duplicate-doc-field
     * duplicate-doc-param
+    * incomplete-signature-doc
     * undefined-doc-class
     * undefined-doc-name
     * undefined-doc-param
@@ -792,6 +797,10 @@ object<string, string>
     */
     "global-in-nil-env": "Any",
     /*
+    Enable diagnostics for function definitions which are not fully annotated.
+    */
+    "incomplete-signature-doc": "None",
+    /*
     Enable diagnostics for accesses to fields which are invisible.
     */
     "invisible": "Any",
@@ -800,6 +809,10 @@ object<string, string>
     */
     "lowercase-global": "Any",
     /*
+    Enable diagnostics for global function definitions which are not fully annotated.
+    */
+    "missing-global-doc": "None",
+    /*
     Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.
     */
     "missing-parameter": "Any",
@@ -1044,6 +1057,10 @@ object<string, string>
     */
     "global-in-nil-env": "Warning",
     /*
+    Enable diagnostics for function definitions which are not fully annotated.
+    */
+    "incomplete-signature-doc": "Warning",
+    /*
     Enable diagnostics for accesses to fields which are invisible.
     */
     "invisible": "Warning",
@@ -1052,6 +1069,10 @@ object<string, string>
     */
     "lowercase-global": "Information",
     /*
+    Enable diagnostics for global function definitions which are not annotated.
+    */
+    "missing-global-doc": "Warning",
+    /*
     Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.
     */
     "missing-parameter": "Warning",

doc/zh-cn/config.md

@@ -240,6 +240,7 @@ Array<string>
 * ``"exp-in-action"``
 * ``"global-element"``
 * ``"global-in-nil-env"``
+* ``"incomplete-signature-doc"``
 * ``"index-in-func-name"``
 * ``"invisible"``
 * ``"jump-local-scope"``
@@ -284,6 +285,7 @@ Array<string>
 * ``"miss-sep-in-table"``
 * ``"miss-space-between"``
 * ``"miss-symbol"``
+* ``"missing-global-doc"``
 * ``"missing-parameter"``
 * ``"missing-return"``
 * ``"missing-return-value"``
@@ -449,6 +451,8 @@ object<string, string>
     * duplicate-doc-alias
     * duplicate-doc-field
     * duplicate-doc-param
+    * incomplete-signature-doc
+    * missing-global-doc
     * undefined-doc-class
     * undefined-doc-name
     * undefined-doc-param
@@ -572,6 +576,8 @@ object<string, string>
     * duplicate-doc-alias
     * duplicate-doc-field
     * duplicate-doc-param
+    * incomplete-signature-doc
+    * missing-global-doc
     * undefined-doc-class
     * undefined-doc-name
     * undefined-doc-param
@@ -792,6 +798,10 @@ object<string, string>
     */
     "global-in-nil-env": "Any",
     /*
+    Enable diagnostics for function definitions which are not fully annotated.
+    */
+    "incomplete-signature-doc": "None",
+    /*
     Enable diagnostics for accesses to fields which are invisible.
     */
     "invisible": "Any",
@@ -800,6 +810,10 @@ object<string, string>
     */
     "lowercase-global": "Any",
     /*
+    Enable diagnostics for global function definitions which are not fully annotated.
+    */
+    "missing-global-doc": "None",
+    /*
     Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.
     */
     "missing-parameter": "Any",
@@ -1043,6 +1057,10 @@ object<string, string>
     */
     "global-in-nil-env": "Warning",
     /*
+    Enable diagnostics for function definitions which are not fully annotated.
+    */
+    "incomplete-signature-doc": "Warning",
+    /*
     Enable diagnostics for accesses to fields which are invisible.
     */
     "invisible": "Warning",
@@ -1051,6 +1069,10 @@ object<string, string>
     */
     "lowercase-global": "Information",
     /*
+    Enable diagnostics for global function definitions which are not annotated.
+    */
+    "missing-global-doc": "Warning",
+    /*
     Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.
     */
     "missing-parameter": "Warning",

doc/zh-tw/config.md

@@ -240,6 +240,7 @@ Array<string>
 * ``"exp-in-action"``
 * ``"global-element"``
 * ``"global-in-nil-env"``
+* ``"incomplete-signature-doc"``
 * ``"index-in-func-name"``
 * ``"invisible"``
 * ``"jump-local-scope"``
@@ -284,6 +285,7 @@ Array<string>
 * ``"miss-sep-in-table"``
 * ``"miss-space-between"``
 * ``"miss-symbol"``
+* ``"missing-global-doc"``
 * ``"missing-parameter"``
 * ``"missing-return"``
 * ``"missing-return-value"``
@@ -449,6 +451,8 @@ object<string, string>
     * duplicate-doc-alias
     * duplicate-doc-field
     * duplicate-doc-param
+    * incomplete-signature-doc
+    * missing-global-doc
     * undefined-doc-class
     * undefined-doc-name
     * undefined-doc-param
@@ -572,6 +576,8 @@ object<string, string>
     * duplicate-doc-alias
     * duplicate-doc-field
     * duplicate-doc-param
+    * incomplete-signature-doc
+    * missing-global-doc
     * undefined-doc-class
     * undefined-doc-name
     * undefined-doc-param
@@ -792,6 +798,10 @@ object<string, string>
     */
     "global-in-nil-env": "Any",
     /*
+    Enable diagnostics for function definitions which are not fully annotated.
+    */
+    "incomplete-signature-doc": "None",
+    /*
     Enable diagnostics for accesses to fields which are invisible.
     */
     "invisible": "Any",
@@ -800,6 +810,10 @@ object<string, string>
     */
     "lowercase-global": "Any",
     /*
+    Enable diagnostics for global function definitions which are not fully annotated.
+    */
+    "missing-global-doc": "None",
+    /*
     Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.
     */
     "missing-parameter": "Any",
@@ -1043,6 +1057,10 @@ object<string, string>
     */
     "global-in-nil-env": "Warning",
     /*
+    Enable diagnostics for function definitions which are not fully annotated.
+    */
+    "incomplete-signature-doc": "Warning",
+    /*
     Enable diagnostics for accesses to fields which are invisible.
     */
     "invisible": "Warning",
@@ -1051,6 +1069,10 @@ object<string, string>
     */
     "lowercase-global": "Information",
     /*
+    Enable diagnostics for global function definitions which are not annotated.
+    */
+    "missing-global-doc": "Warning",
+    /*
     Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.
     */
     "missing-parameter": "Warning",

locale/en-us/script.lua

@@ -114,6 +114,16 @@ DIAG_UNDEFINED_DOC_NAME               =
 'Undefined type or alias `{}`.'
 DIAG_UNDEFINED_DOC_PARAM              =
 'Undefined param `{}`.'
+DIAG_MISSING_GLOBAL_DOC_COMMENT       =
+'Missing comment for global function `{}`.'
+DIAG_MISSING_GLOBAL_DOC_PARAM         =
+'Missing @param annotation for parameter `{}` in global function `{}`.'
+DIAG_MISSING_GLOBAL_DOC_RETURN        =
+'Missing @return annotation at index `{}` in global function `{}`.'
+DIAG_INCOMPLETE_SIGNATURE_DOC_PARAM   =
+'Incomplete signature. Missing @param annotation for parameter `{}` in function `{}`.'
+DIAG_INCOMPLETE_SIGNATURE_DOC_RETURN  =
+'Incomplete signature. Missing @return annotation at index `{}` in function `{}`.'
 DIAG_UNKNOWN_DIAG_CODE                =
 'Unknown diagnostic code `{}`.'
 DIAG_CAST_LOCAL_TYPE                  =

locale/en-us/setting.lua

@@ -373,8 +373,12 @@ config.diagnostics['duplicate-doc-param']   =
 'Enable diagnostics for a duplicated param annotation name.'
 config.diagnostics['duplicate-set-field']   =
 'Enable diagnostics for setting the same field in a class more than once.'
+config.diagnostics['incomplete-signature-doc']    =
+'Incomplete @param or @return annotations for functions.'
 config.diagnostics['invisible']             =
 'Enable diagnostics for accesses to fields which are invisible.'
+config.diagnostics['missing-global-doc']    =
+'Missing annotations for globals! Global functions must have a comment and annotations for all parameters and return values.'
 config.diagnostics['missing-parameter']     =
 'Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.'
 config.diagnostics['missing-return']        =

locale/pt-br/script.lua

@@ -114,7 +114,17 @@ DIAG_UNDEFINED_DOC_NAME               =
 'Tipo ou alias indefinido `{}`.'
 DIAG_UNDEFINED_DOC_PARAM              =
 'Parâmetro indefinido `{}`.'
-DIAG_UNKNOWN_DIAG_CODE                =
+DIAG_MISSING_GLOBAL_DOC_COMMENT       = -- TODO: need translate!
+'Missing comment for global function `{}`.'
+DIAG_MISSING_GLOBAL_DOC_PARAM         = -- TODO: need translate!
+'Missing @param annotation for parameter `{}` in global function `{}`.'
+DIAG_MISSING_GLOBAL_DOC_RETURN        = -- TODO: need translate!
+'Missing @return annotation at index `{}` in global function `{}`.'
+DIAG_INCOMPLETE_SIGNATURE_DOC_PARAM   = -- TODO: need translate!
+'Incomplete signature. Missing @param annotation for parameter `{}` in function `{}`.'
+DIAG_INCOMPLETE_SIGNATURE_DOC_RETURN  = -- TODO: need translate!
+'Incomplete signature. Missing @return annotation at index `{}` in function `{}`.'
+DIAG_UNKNOWN_DIAG_CODE                = -- TODO: need translate!
 'Código de diagnóstico desconhecido `{}`.'
 DIAG_CAST_LOCAL_TYPE                  = -- TODO: need translate!
 'This variable is defined as type `{def}`. Cannot convert its type to `{ref}`.'

locale/pt-br/setting.lua

@@ -373,8 +373,12 @@ config.diagnostics['duplicate-doc-param']   = -- TODO: need translate!
 'Enable diagnostics for a duplicated param annotation name.'
 config.diagnostics['duplicate-set-field']   = -- TODO: need translate!
 'Enable diagnostics for setting the same field in a class more than once.'
+config.diagnostics['incomplete-signature-doc'] = -- TODO: need translate!
+'Incomplete @param or @return annotations for functions.'
 config.diagnostics['invisible']             = -- TODO: need translate!
 'Enable diagnostics for accesses to fields which are invisible.'
+config.diagnostics['missing-global-doc']    = -- TODO: need translate!
+'Missing annotations for globals! Global functions must have a comment and annotations for all parameters and return values.'
 config.diagnostics['missing-parameter']     = -- TODO: need translate!
 'Enable diagnostics for function calls where the number of arguments is less than the number of annotated function parameters.'
 config.diagnostics['missing-return']        = -- TODO: need translate!

locale/zh-cn/script.lua

@@ -114,6 +114,16 @@ DIAG_UNDEFINED_DOC_NAME               =
 '未定义的类型或别名 `{}`。'
 DIAG_UNDEFINED_DOC_PARAM              =
 '指向了未定义的参数 `{}`。'
+DIAG_MISSING_GLOBAL_DOC_COMMENT       = -- TODO: need translate!
+'Missing comment for global function `{}`.'
+DIAG_MISSING_GLOBAL_DOC_PARAM         = -- TODO: need translate!
+'Missing @param annotation for parameter `{}` in global function `{}`.'
+DIAG_MISSING_GLOBAL_DOC_RETURN        = -- TODO: need translate!
+'Missing @return annotation at index `{}` in global function `{}`.'
+DIAG_INCOMPLETE_SIGNATURE_DOC_PARAM   = -- TODO: need translate!
+'Incomplete signature. Missing @param annotation for parameter `{}` in function `{}`.'
+DIAG_INCOMPLETE_SIGNATURE_DOC_RETURN  = -- TODO: need translate!
+'Incomplete signature. Missing @return annotation at index `{}` in function `{}`.'
 DIAG_UNKNOWN_DIAG_CODE                =
 '未知的诊断代号 `{}`。'
 DIAG_CAST_LOCAL_TYPE                  =