Where to add a description about file with constants definition. REMARKS / PARAMETERS

[mlipok]

this was discused here:
​http://www.autoitscript.com/forum/topic/153782-help-filedocumentation-issues-discussion-only/page-3#entry1110680

It is the sentence of this discussion:

I would like her to be selected one correct option on how the description of the relevant file, which contains the definition of constants:

the first option (for example, a StringInStr)

parameter description: "Constants are defined in Constants.au3"
and
in Remarks: "The use of the values ​​specified above you must # include <StringConstants.au3> in your script."

the second option (for example, a DirCopy)

parameter description: "Constants are defined in FileConstants.au3"
and
in Remarks: no additional information

there is also a third option but I have not noticed in the present documentation:

in the description of the parameters: no additional information
and
in Remarks: Contains additional information

[TicketCleanup]

Automatic ticket cleanup.

[anonymous]

as an example, please look for GUISetFont
there is used both as GUIConstantsEx.au3 FontConstants.au3, wherein FontConstants.au3 is used twice.

All these files are listed in section Parmeters

I think the solution is clear.
I would suggest possibly before and after
"Constants are defined in ..."
add an extra blank line.

To stand out this information.

[mlipok]

On the other hand, for example, MsgBox () shows an example of display the information concerning constants in the remarks.
in this case, this option is much better because of the amount of information.

[Matt Diesel]

The second option is what I have been using. Will take a look at which docs are doing things differently

[mlipok]

I found an example where it has no specified appropriate file:
GUICtrlCreateListViewItem

[J-Paul Mesnage]

at least the signaled help are fixed in the beta

[J-Paul Mesnage]

Added by revision [9094] in version: 3.3.9.22