Re: [basex-talk] xqdoc and basex system modules

2015-04-07 Thread Christian Grün 
Hi Andy,

Back again... I have fixed xqdoc parsing. Could you give it another
try? The snapshot is available in a few minutes..

Christian


On Tue, Mar 24, 2015 at 5:28 PM, Andy Bunce  wrote:
> I think it is the handling of nested comments:
>
> let $a:='
> (:~
>  : BEFORE (:~ MIDDLE :) AFTER
>  :)
> declare function local:foo(){42};local:foo()
>  '
> return inspect:xqdoc($a)
>
> Result:
>   MIDDLE 
>
> may be confusing [1] indeed.
> /Andy
> [1]
> http://www-01.ibm.com/support/knowledgecenter/SSEPEK_11.0.0/com.ibm.db2z11.doc.xml/src/tpc/db2z_commentxpxq.dita
>
> On 24 March 2015 at 15:54, Christian Grün  wrote:
>>
>> Hi Andy,
>>
>> I have just updated the modules.zip file; maybe the first error is gone?
>>
>>   https://github.com/BaseXdb/basex-dist/blob/master/etc/modules.zip
>>
>> If not, I agree something must go wrong while there must be something
>> wrong with parsing the description as XML.
>>
>> > 2) inspect:xqdoc("array.xqm") and the same with map.xqm
>> >
>> > Function 'array:size' is in reserved namespace. I guess this is to be
>> > expected and maybe I should just ignore any  modules in namespaces
>> > http://www.w3.org/...
>>
>> Exactly. Maybe we should also remove it from the zip file..
>>
>> Thanks,
>> Christian
>
>

Re: [basex-talk] xqdoc and basex system modules

2015-03-24 Thread Andy Bunce 
I think it is the handling of nested comments:

let $a:='
(:~
 : BEFORE (:~ MIDDLE :) AFTER
 :)
declare function local:foo(){42};local:foo()
 '
return inspect:xqdoc($a)

Result:
  MIDDLE 

may be confusing [1] indeed.
/Andy
[1]
http://www-01.ibm.com/support/knowledgecenter/SSEPEK_11.0.0/com.ibm.db2z11.doc.xml/src/tpc/db2z_commentxpxq.dita

On 24 March 2015 at 15:54, Christian Grün  wrote:

> Hi Andy,
>
> I have just updated the modules.zip file; maybe the first error is gone?
>
>   https://github.com/BaseXdb/basex-dist/blob/master/etc/modules.zip
>
> If not, I agree something must go wrong while there must be something
> wrong with parsing the description as XML.
>
> > 2) inspect:xqdoc("array.xqm") and the same with map.xqm
> >
> > Function 'array:size' is in reserved namespace. I guess this is to be
> > expected and maybe I should just ignore any  modules in namespaces
> > http://www.w3.org/...
>
> Exactly. Maybe we should also remove it from the zip file..
>
> Thanks,
> Christian
>

Re: [basex-talk] xqdoc and basex system modules

2015-03-24 Thread Christian Grün 
Hi Andy,

I have just updated the modules.zip file; maybe the first error is gone?

  https://github.com/BaseXdb/basex-dist/blob/master/etc/modules.zip

If not, I agree something must go wrong while there must be something
wrong with parsing the description as XML.

> 2) inspect:xqdoc("array.xqm") and the same with map.xqm
>
> Function 'array:size' is in reserved namespace. I guess this is to be
> expected and maybe I should just ignore any  modules in namespaces
> http://www.w3.org/...

Exactly. Maybe we should also remove it from the zip file..

Thanks,
Christian

[basex-talk] xqdoc and basex system modules

2015-03-23 Thread Andy Bunce 
I am looking to generate documentation from the system module stubs in
etc/modules.zip.
I have two issues

1) There is an issue with inspect.xqm

declare namespace xqdoc="http://www.xqdoc.org/1.0";;
let
$a:=inspect:xqdoc("inspect.xqm")//xqdoc:function[xqdoc:name='inspect:xqdoc']//xqdoc:description
return parse-xml-fragment($a)

Errors
And xqdoc:description looks like
http://www.xqdoc.org/1.0";> and
end with  , and tags start with
@
. xqDoc comments can be specified for main and library modules and variable
and function declarations.

We have slightly extended the xqDoc conventions to do justice to
the current status of XQuery (Schema: xqdoc-1.1.30052013.xsd):

  
     
  •  an
<xqdoc:annotations/> node is added
to each variable or function that uses annotations. The xqdoc:annotation
child nodes may have additional xqdoc:literal
elements with type attributes (xs:string,
xs:integer, xs:decimal, xs:double) and values. 
    •  
  •  a
single <xqdoc:namespaces/> node is
added to the root element, which summarizes all prefixes and namespace URIs
used or declared in the module. 
    •  
  •  name and type
elements are added to variables 
    •  


A comment parsing/escaping issue?

2) inspect:xqdoc("array.xqm") and the same with map.xqm

Function 'array:size' is in reserved namespace. I guess this is to be
expected and maybe I should just ignore any  modules in namespaces
http://www.w3.org/...
I guess it is a result of the code being compiled rather than just
documented?

/Andy