OpenEuphoria

Re: Error when tryijng to use Upper()

• Posted by Derek Parnell <ddparnell at bigpond.com> Oct 17, 2003
• 450 views

----- Original Message ----- 
From: <Louis at cwshop.com>
To: "EUforum" <EUforum at topica.com>
Subject: Re: Error when tryijng to use Upper()


> 
> 
> I, too, struggle with the documentation.  OK, Here's the problem.  
>We go to Win32Lib  index.htm, press Ctl-F and search for "ES_UPPER" 
>or "SelText" and find nothing.  You will say this is because index.htm
>is only one of 44 files of HTML documentation.  I say I don't have 
>time to initiate up to 44 separate searches to locate the explanation
> for "ES_UPPER".

Its worse than that...there *is* no explanation of ES_UPPERCASE and SelText in
the win32lib docs. This is because I'm not likely to describe the Microsoft
defined constants or API routines in Win32lib's documentation. Think of it this
way, if I write a book to describe the workings of a Porsche 911, you would still
have to go else where to learn how to drive.

There are many sources of information about the Microsoft Windows API, and all
better written than I could ever do.

On the other hand, if you wish to pay me large amounts, I might be persuaded to
add extra to the free win32lib documentation.

> Two possible solutions come to mind...
> 1.  Someone could write a search tool.
> 2.  A link could be placed in index.htm for "EX_*" (I assume all of
> them are in one file) so we could find them in two steps.  
>Hopefully, a similar thing would be done for the other batches of constants.

Well, yes and no.  The search tool could be created, but the content to search
for is still not there.

> Idea for the (perhaps distant) future - design special flags to put
>in the comments in Win32Lib source (or any source) which allow a 
>documentation generator to produce documentation for the program.  
>That way, when the source is changed, it will only be necessary to
>run docgen to make new documentation.  It could produce a text file
> with HTML links, and the single file could be easily searched.

Ummm...that's how its done now. Have you looked at the comments in the library?
They are sprinkled with markup codes already so that the MakeDoc program can
generate the HTML code.

For example...

--/topic Events
--/func subClassControl(sequence Id,  atom hWnd)
--/desc Used to access Windows created controls as if they were win32lib
controls.
--/return INTEGER: A win32lib control id. ZERO if it fails.
-- /i Id is a sequence {ControlType, ParentID} /n
-- /i hWnd is the Windows Handle to the control.
--
--Example
--/code
--    newid = subClassControl( {EditText, myWindow}, winhandle)
--/endcode

generates an entry in the EVENTS.HTM file (the topic) about a function called
'subClassControl'.

-- 
Derek