IDL Problem Code 49 with alias no-args-to-doc

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 contains arguments, but you don't have any in your routine definition.

Here's an example:

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

To fix it, either remove the comments or add the argument

Fix: Add Argument

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

Fix: Remove Docs

;+
; :Returns: Number
;-
function myfunc
  compile_opt idl2
  return, 42
end