Help File/Documentation Issues. (Discussion Only)

[AZJIO]

You can make the article bit flag. In functions BitOR and BitAND make reference to article.

I have already done - Ru

[mLipok]

in the "AutoIt Syntax Checker (Au3Check)"

a description of these directives:

# forcedef

# forceref

# ignorefunc

 

According to me, this description is not very clear.

I mean it does not say what is the effect of the Directive is only mentioned about the fact that this can be used in a particular way.

 

Please read the description in this part of the documentation and look at it from the point of view of a novice.

 

I on my part I just had to guess what is the use of these directives. It did not take me much time can, but I have the impression that this description was created with the assumption that certain things are implicitly and remained vague.

 

Are my thoughts make sense?

[Melba23]

mlipok,

I will add something to help explain.

M23

[mLipok]

Thanks

[Melba23]

mlipok,

Added the following explanation:

 

These directives prevent Au3Check from reporting errors when the code is correct but too complex for the tool's parser. As shown in the examples below they are usually used when variables are implicitly declared - such as in a function definition or by a string parameter - and would otherwise not be recognised. In particular, #forceref can be used to prevent warnings where parameters are mandatory (such as in Windows message handlers) but are not used inside the function.

In my opinion, if the user is such a novice that they do not understand that, then they should not be using the directives anyway.

M23

P.S. And yes, guinness, I used Notepad to change it.

[mLipok]

very clearly explained

 

I greet

mlipok

[guinness]

  On 11/28/2013 at 10:55 AM, Melba23 said:

P.S. And yes, guinness, I used Notepad to change it.

Thanks.

[mLipok]

Is the process of modifying HelpFile, is created with the assumption not to use MAGIC NUMBER?

 

Is the reported cases in which the appropriate changes have not yet been introduced.

 

for example:

"FileConstants.au3" does not contain variables for the parameter "flag" for function "FileSelectFolder".

 

 

EDIT:

some more such cases are in descripion for this function:

 

FileCreateNTFSLink

FileGetEncoding

FileGetShortName

FileGetTime

FileSetTime

Edited December 3, 2013 by mlipok

[Mat]

It's been an ongoing project for a long time now to get rid of all the magic numbers. There are a lot of them.

[guinness]

I agree with Mat, it's taken years for AutoIt to get this far so resolving "issue" such as this isn't a couple of days & voila type of thing.

[l3ill]

Do you want to know about spelling errors here?

[guinness]

If they are not present in v3.3.9.24 then post to Trac please.

Edited December 9, 2013 by guinness

[guinness]

All done billo. Thanks for the requests and you should see this in the next version of AutoIt.

[Iczer]

Always wanted to ask - is it possible to make load *default* browser if i click on link in chm help? I mean non-IE browser?

 

also - it seems for me there are non-correct links for msdn-related functions in help file:

_WinAPI_MultiByteToWideChar()

link in help, lead to "Unable to Service Request" page:

http://msdn.microsoft.com/query/dev10.query?appId=Dev10IDEF1&l=EN-US&k=k(MultiByteToWideChar);k(DevLang-C);k(TargetOS-WINDOWS)&rd=true

correct one:

http://msdn.microsoft.com/en-us/library/windows/desktop/dd374130%28v=vs.85%29.aspx

[jpm]

I don't understand foir _WinAPI_MultiByteToWideChar as with the beta .chm I get the correct one

[Iczer]

i get redirected to http://msdn.microsoft.com/Areas/Epx/Content/500.htm?aspxerrorpath=/query/dev10.query#352006469442859382

i mean beta help

Edited December 10, 2013 by Iczer

[Mat]

The links aren't actually generated for the helpfile pages, instead what is generated is a search query.

However, both the links in your post #234 work for me, and the link works from the helpfile for me too.

[jpm]

  On 12/10/2013 at 3:15 PM, Iczer said:

i get redirected to http://msdn.microsoft.com/Areas/Epx/Content/500.htm?aspxerrorpath=/query/dev10.query#352006469442859382

i mean beta help

certainly related with yur environment (Windows, ...), I am running Windows8.1/IE11 (Fr)

[guinness]

Don't be afraid to keep those issues and improvements coming.

[JohnOne]

I think the all UDF _Array* functions should note either in description or remarks if they are for 1 dimensional arrays.