[jawsscripts] Re: Script documentation question
- From: "Geoff Chapman" <gch@xxxxxxxxxxxxxxxx>
- To: <jawsscripts@xxxxxxxxxxxxx>
- Date: Thu, 26 Jul 2012 07:30:47 +1000
wow paul, that's an awesome description! thanks for posting that. I for one
didn't know you had to remove and re-add params in order to add descriptions
to them. Shows how often I've done this eh. :) Thanks for posting.
At least you understood the gentleman's issues right off the bat!
Geoff C.
----- Original Message -----
From: "Paul Magill" <magills@xxxxxxxxxxx>
To: <jawsscripts@xxxxxxxxxxxxx>
Sent: Wednesday, July 25, 2012 11:37 PM
Subject: [jawsscripts] Re: Script documentation question
> Hi,
>
> I have done that too...
>
> The .jsd file can be manually edited to add the descriptions, but it is
> easier to do it through the script manager with the .jss file.
>
> Just place the PC cursor in the function body or header, & press
> control+D.
>
> That opens the same dialog as when you created the function.
>
> Tab around & enter the synopsis, description & the return description if
> the
> function returns something.
>
> Now, control+tab will take you to the parameter page.
>
> It is not possible to add descriptions to already existing parameters, so
> you need to first remove them & replace them with exactly the same name &
> type, this time including the descriptions.
>
> You will be at the top of the parameter list, so arrow to bring focus to
> the first parameter.
>
> note the type, & exact spelling of the parameters name, then hit Alt+R to
> remove the first parameter.
>
> That will immediately put you on the new parameter name field, so enter
> the
> name that you just removed, then tab & enter the description for that
> parameter.
>
> Then just tab & choose the type & hit the Add button.
>
> On hitting Add, the focus will again go to the new parameter name field.
> If
> there is only 1 parameter for the function, tab to the ok button & hit
> that.
> You will be ready to recompile.
>
> If there is more than 1 parameter, then back tab to the parameter list,
> and
> repeat the above, removing the one that is at the top of the list now.
>
> Repeat this for all the parameters, then hit ok, & you are ready to
> recompile.
>
> Hope this helps,
> Paul from Australia
>
> ----- Original Message -----
> Hi listers
> I wrote some user define function, including parameter, but forget to add
> description. Now I want to do it. So what should I do?
> I open my JSD file to add, but it sound not work. Please help me.
> Thanks for reading e-mail.
> ________________
> Dang Manh Cuong
> HCMC University of Pedagogy:
>
> __________�
>
> View the list's information and change your settings at
> //www.freelists.org/list/jawsscripts
>
>
__________�
View the list's information and change your settings at
//www.freelists.org/list/jawsscripts
Other related posts:
