IDL Problem Code 79 with alias docs-missing-struct

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 issue detects when a structure definition is missing from the documentation for the procedure it is contained in.

Here is an example of the problem:

;+
;
;-
pro MyStruct__define
  compile_opt idl2

  void = {MyStruct, prop1: '', prop2: 42}
  ;       ^^^^^^^^ missing from docs
end

Which can be fixed by adding the structure to the docs:

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

  void = {MyStruct, prop1: '', prop2: 42}
  ;       ^^^^^^^ OK!
end