IonicWind Software

IWBasic => Documentation Bugs => Topic started by: LarryMc on July 11, 2009, 12:16:48 PM

Title: Documentation Bugs
Post by: LarryMc on July 11, 2009, 12:16:48 PM
Paul,
Suggest you create new forum with this topic's name.
Low priority but items that need to be corrected.


string = REGGETDWORD(string key, pointer ValueName, opt defValue as UINT)

should be:

uint = REGGETDWORD(string key, pointer ValueName, opt defValue as UINT)

Larry
Title: Re: Documentation Bugs
Post by: Duffer on July 11, 2009, 12:46:11 PM
Did Larry just volunteer to write the final documentation for Aurora?  ;D ;)
Title: Re: Documentation Bugs
Post by: LarryMc on July 11, 2009, 02:31:26 PM
Nice try Brice :D
This is the EB forum.

Plus, I wrote a program way back that generated help file skeletons based upon the inc files and we tried to get people to flesh them out.

Everybody(except for a couple) basically scattered and I didn't know enough to do it by myself.

Paul wound up hiring the tech writer to do it.

Turn about is fair play ;)
Did you just volunteer to proof the documentation and identify all the commands that aren't documented properly?

Some have typos as I mentioned above.
Some show up in search but not in the index and vice versa (if I remember correctly).

At least you won't have to elbow your way into because of all the people wanting to do it.

But really, there aren't that many issues considering the volume of documentation.

Larry


Title: Re: Documentation Bugs
Post by: Duffer on July 12, 2009, 02:13:48 AM
I was teasing ya, as Paul had recently said the main reason Aurora hasn't had a 1.0 release is the documentation.  There still seems to be a lot of work to be done on the gaming side, but I don't know how much of a help I could be as I can't make heads or tails out of the 3D.  I guess it would be a matter of working off of the EB docs?

Send me a PM if you want to discuss this further.
Title: Re: Documentation Bugs
Post by: LarryMc on July 12, 2009, 02:25:43 PM
QuoteI was teasing ya
And I back at you.
Sounds like you're in the same boat as me.

Larry
Title: Re: Documentation Bugs
Post by: Allan on July 12, 2009, 08:33:24 PM
Have one for you Larry.

Control Pak Guide - tcSetMinTabSize - See Example usage.

Title: Re: Documentation Bugs
Post by: LarryMc on July 13, 2009, 08:27:59 AM
This ate my lunch for a couple of hours:

From the richedit portion of the windows controls section.

QuoteCONTROLCMD window | dialog, ID, @RTSCROLL, lines, chars

I was trying to fix a problem with resetting the vertical scroll position

the help file says lines, chars (in that order)

the command won't cause a scroll up/down(by lines) unless you enter the number of lines in the latter(chars) position

Larry
Title: Re: Documentation Bugs
Post by: LarryMc on July 17, 2009, 02:54:53 PM

MODIFYSTYLE and MODIFYEXSTYLE do not appear in the help file index
but they do appear in a search.

Larry
Title: Re: Documentation Bugs
Post by: Duffer on July 24, 2009, 07:00:41 PM
Quote from: Larry McCaughn on July 12, 2009, 02:25:43 PM
QuoteI was teasing ya
And I back at you.
Sounds like you're in the same boat as me.

Larry

I wasn't joking in the last reply.  I am happy to help on the unfinished docs for Aurora.  The 3D should really just be a cause of working from the EB docs and converting everything to Aurora syntax.  Seriously, send me a PM if you want to get working on this.
Title: Re: Documentation Bugs
Post by: LarryMc on August 07, 2009, 03:29:33 AM
PROJECTGLOBAL does not appear in the documentation

Larry