IDL Problem Code 83 with alias docs-prop-too-many-params

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 problem indicates that the documentation for a structure property has more information than just the type.

At the time of writing this doc, the properties should only include the type and no additional information like arguments or parameters.

Here is an example of the problem:

;+
; :MyStruct:
;   prop1: in, required, String
;     First property
;   prop2: in, required, Number
;     Second property
;
;-
pro MyStruct__define
  compile_opt idl2

  void = {MyStruct, prop1: '', prop2: 42}
end

Which can be fixed by removing everything else besides the type:

;+
; :MyStruct:
;   prop1: String
;     First property
;   prop2: Number
;     Second property
;
;-
pro MyStruct__define
  compile_opt idl2

  void = {MyStruct, prop1: '', prop2: 42}
end