[ 
https://issues.apache.org/jira/browse/JEXL-233?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16069812#comment-16069812
 ] 

Henri Biestro commented on JEXL-233:
------------------------------------


I was just wondering myself about the numerous missing (or shallow) elements of 
documentation, starting with the (dreadful) introductory example and the (so) 
many ways we can now customize JEXL to expose objects and methods.
About the syntax though, I've always looked at it from an 'end-user' 
prospective. I'm not sure it is the place to differentiate between duck-types 
and indexed-container; again, from an end-user prospective, the variables 
exposed and their types, including their properties and wether they 
appear/behave as arrays, as well as the functions and namespaces, should be 
documented separately. These should be part of the reference manual 
accompanying the platform that uses JEXL as scripting engine. But as an 
end-user, I should not have to make the distinctions between all those 
different property accessors. And the syntax reference should remain free of 
them (imho).
It is true though that somewhere is missing a good overview of the different 
means of exposing properties or functions to the engine (Javadoc covers some) 
including their resolution orders. Good examples/use cases would certainly make 
a huge difference.

> Documentation rewrite
> ---------------------
>
>                 Key: JEXL-233
>                 URL: https://issues.apache.org/jira/browse/JEXL-233
>             Project: Commons JEXL
>          Issue Type: Improvement
>    Affects Versions: 3.1
>            Reporter: Dmitri Blinov
>            Priority: Minor
>         Attachments: syntax.xml
>
>
> I have reorganized the JEXL syntax doc, basically adjusted the document 
> structure to be more logical in my view, and brushed up some descriptions.
> Comments are welcome! If it is ok, please promote the attachment to the 
> source tree. 



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Reply via email to