Hi all
Here are some new features and important things to note when documenting
your component xml files
http://public.dev.nuxeo.com/~lgodard/nxpointdoc/index.html
- xhtml tag supporting
As requested, <documentation> now supports and render xhtml tags.
Then, you'll have to review all your documentation to enclose any xml
snippet in a <pre> </pre> otherwise the documentation will not render
correctly
Moreover, we can not ensure xhtml 1.0 strict validity anymore. Please be
carefull when writting html tags in your comments.
Some other places such as @author also supports xhtml (mainly for links)
more to come (see below)
- Maven apidocs connection
Implementation and object of extension points are now linked to the
maven apidocs http://maven.nuxeo.org/apidocs/
- Satistics
The GDC (Global Documentation Coverage) is growing !! that's great !!
Keep an eye on it and make the page as blue as possible
http://public.dev.nuxeo.com/~lgodard/nxpointdoc/_statistics.html
- Missing information
Author information is sometimes given but version is always missing
please take care of it
- Multiple author
Now components, extension points and contributions can have multiple authors
i'll update the documentation accordingly tomorrow
- comming & question
we need to implement explicit pointers [EMAIL PROTECTED] but have 2 targets
the nxpointdoc and the javadoc
as i've already seen some @see pointing on javadoc, i propose to keep it
for this purpose
what name to take for referencing a pointer to nxpointdoc ? is a
@component suitable ? any other name ?
So, NxPointDoc is still under development and any feedback and
suggestion is welcommed. Feel free to contact me
HTH
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
