[Exist-development] A proposed addition to the XQDocs

[Loren C. <lor...@gm...>]

Hello folks,

I am thinking that the functions docs could use an enhancement.  I was looking at the function docs for scheduler:get-secheduled-jobs()


get-scheduled-jobs

scheduler:get-scheduled-jobs() node()
Gets the details of all scheduled jobs in the form: <scheduler:jobs xmlns:scheduler="http://exist-db.org/xquery/scheduler" count="iJobs"> <scheduler:group name="group"> <scheduler:job name=""> <scheduler:trigger name=""> <expression></expression> <state></state> <start></start> <end></end> <previous></previous> <next></next> <final></final> </scheduler:trigger> </scheduler:job> </scheduler:group></scheduler:jobs>

Parameters:
$a	$a
Returns:
the XML containing the list of jobs

I am thinking that there should be an option to add an XSD or a Relax NG to a parameter or the return value and then display a graphic of the schema of the value.  I will work on this, but would like some feedback from the group as to a proper mechanism to add this to the XQDocs in any XQuery code.  The java implemented function modules should be pretty straight forward to implement after this decision.


I am thinking that the description should be changed to 'Get the details of all scheduled jobs.' and the returns show something similar to the attached:



What do you think?

Cheers,
Loren