GLBasic forum

Main forum => GLBasic - en => Topic started by: Uncle on 2009-Aug-29

Title: Does the Help Creator work with the latest version?
Post by: Uncle on 2009-Aug-29
Hello,

AndyH just pointed out that GLB has its own help creator.  I've tried to get it working but I can't seem to get any text to flow through to the help file.  Anybody got any tips?  Also in the example shown in the help file the function has an @ sign in front of it.  What does this do?

Cheers,


Andrew
Title: Re: Does the Help Creator work with the latest version?
Post by: Uncle on 2009-Aug-29
Cheers Ocean thats handy to know :)  Do you have any more top tips like that?
Title: Re: Does the Help Creator work with the latest version?
Post by: Hemlos on 2009-Aug-29
Yes, the latest version will create a help file.

Code (glbasic) Select
// \param myexample$ - my example parameter
//! myexample$ is a string parameter
// \return data is passed through in this example
FUNCTION TEST: myexample$
RETURN myexample$
ENDFUNCTION


This example will be found as projectname.gbas.html

Note: @ shouldnt have an affect on building a help file, this is merely a feature inside the editor, and has no affect concerning your program.
Title: Re: Does the Help Creator work with the latest version?
Post by: Uncle on 2009-Aug-29
Doh!  Just worked out what I was doing wrong.  I was typing in the notes as described, but I hadn't actually saved the sourced coded before running the create help option.  ;/