IDL Problem Code 64 with alias docs-param-missing

Want to disable me? Check out the configuration guide to learn more.

Documentation Best Practice

This problem indicates that there's an opportunity to improve the documentation for your code.

This helps make sure the extension can properly detect types, provide a better user experience, and ensures other users can be successful with code that you write.

Want to automate documentation generation? Learn about comment style and AutoDoc here.

This error is reported when your documentation is missing an argument or keyword from the routine definition.

Here's an example:

;+
; :Returns: Number
;
; :Arguments:
;   arg1: in, required, Number
;     My favorite arg
;
;-
function myfunc, arg1, arg2
  ;                    ^^^^ docs missing argument
  compile_opt idl2
  return, 42 + arg1
end

To fix it, add the argument to the documentation:

;+
; :Returns: Number
;
; :Arguments:
;   arg1: in, required, Number
;     My favorite arg
;   arg2: in, required, Number
;     My second-favorite arg
;
;-
function myfunc, arg1, arg2
  compile_opt idl2
  return, 42 + arg1
end