Search in iMatch documentation

Started by Carlo Didier, November 17, 2017, 02:20:18 PM

Previous topic - Next topic

Carlo Didier

The search doesn't really work as expected.
Example attached. I entered "shellexec" and clicked on the loupe.
That gave me as result "Class:IMatch". Not really what I was looking for, but I clicked on it to see.
That brought me to where I could actually find what I was looking for, but only after several attemps did I find out that I had to scroll down the list on the right and "manually" look for "shellexecute" ...
The search should have brought me directly to that point, otherwise its plain useless and only makes you think what you're looking for isn't there at all.

Mario

#1
I use a 3rd party tool to produce the help from the source codes.
Feel free to forward your complaint to the authors of the JSDOC utilities or the author(s) of the grunt-jsdoc (https://github.com/krampstudio/grunt-jsdoc) module I run via grunt to produce the documentation from .js comments and markdown files.

Do you know that you can just search with <Ctrl>+<F> in your browser?
Do you know that you can just search the imatchlib.js file in your editor? All the documentation is automatically generated from the comments in that file (and the comments in the imwslib.js file).

Jingo

Was going to mention the imatchlib.js file.... good stuff in there!!

Carlo Didier

Quote from: Mario on November 17, 2017, 03:01:02 PM
I use a 3rd party tool to produce the help from the source codes.
Feel free to forward your complaint to the authors of the JSDOC utilities or the author(s) of the grunt-jsdoc (https://github.com/krampstudio/grunt-jsdoc) module I run via grunt to produce the documentation from .js comments and markdown files.
:'(

Quote from: Mario on November 17, 2017, 03:01:02 PM
Do you know that you can just search with <Ctrl>+<F> in your browser?
Yes, but for that I first have to get to the page where I can find what I'm searching for (and realize that I am already at the right place!)

Quote from: Mario on November 17, 2017, 03:01:02 PM
Do you know that you can just search the imatchlib.js file in your editor? All the documentation is automatically generated from the comments in that file (and the comments in the imwslib.js file).
If I have to do that, than I don't need the documentation ... Or I'll write an app which searches inside that file for me  :)

Jingo

Quote from: Carlo Didier on November 17, 2017, 04:44:14 PM
Quote from: Mario on November 17, 2017, 03:01:02 PM
I use a 3rd party tool to produce the help from the source codes.
Feel free to forward your complaint to the authors of the JSDOC utilities or the author(s) of the grunt-jsdoc (https://github.com/krampstudio/grunt-jsdoc) module I run via grunt to produce the documentation from .js comments and markdown files.
:'(

Quote from: Mario on November 17, 2017, 03:01:02 PM
Do you know that you can just search with <Ctrl>+<F> in your browser?
Yes, but for that I first have to get to the page where I can find what I'm searching for (and realize that I am already at the right place!)

Quote from: Mario on November 17, 2017, 03:01:02 PM
Do you know that you can just search the imatchlib.js file in your editor? All the documentation is automatically generated from the comments in that file (and the comments in the imwslib.js file).
If I have to do that, than I don't need the documentation ... Or I'll write an app which searches inside that file for me  :)

The main Developer Notes page has most of the information you need to create the apps... I keep this page bookmarked and pull it up when needed - then just do a simple Ctrl-F to jump to the section I need.  Also, the documentation app is pretty complete as well - I typically copy this to Notepad++ on each release and keep it open for easy and quick reference as well.  Finally - a search through imatchlib.js gives you the functions to review if you still have questions about something... nothing like looking at the source files to fully understand what a function really does!