Hi all
Laurent will send a mail with details.
thanks eric
well, not that much detailled needed
the use is quite straightforward. accordong to the README, you'll need
elementree and genshi as python tools
if you seraching for example, the index lines containing comments and
details are comming from pages that are already documented
eg.
http://public.dev.nuxeo.com/~lgodard/nxpointdoc/org.nuxeo.runtime.remoting.RemotingService.html
http://public.dev.nuxeo.com/~lgodard/nxpointdoc/org.nuxeo.ecm.core.api.DocumentAdapterService.html#extension_point_adapters
To learn how to document your extension points, please see:
<http://svn.nuxeo.org/trac/nuxeo/browser/tools/nxpointdoc/doc/DocumentingComponents.odt?format=raw>.
IMPORTANT
the <comment> tags have to be substituted to <documentation> tags
the documentation is actually being updated
one or two javadoc attributes are not supported yet (@see and
@deprecated) - i'll add this tomorrow
Do not hesitate to send feedback on this documentation system. It will
evolve to better match future requirements. For now it's designed to be
simple enough to enable easy documentation and maintenance of extension
points.
Feel free to give me any feedback and requests
the goal is to remain simple but usefull, so every idea is welcommed
I'll probably add some coverage statistics in the coming days (% of
documented components, extension points, aso)
Laurent
--
Laurent Godard <[EMAIL PROTECTED]> - Ingénierie OpenOffice.org -
http://www.indesko.com
Nuxeo Enterprise Content Management >> http://www.nuxeo.com -
http://www.nuxeo.org
Livre "Programmation OpenOffice.org", Eyrolles 2004-2006
_______________________________________________
ECM mailing list
[email protected]
http://lists.nuxeo.com/mailman/listinfo/ecm
