[xwiki-devs] [Idea] Automatically attach the javadoc of XWiki APIs to a document in XE
Hello devs, I am thinking it would be good to automatically attach the javadoc generated for XWiki apis (XWiki, Document, Context, Utils, etc) + maybe velocity tools (listtool, mathtool, etc.) in a wiki document of XE at build time. We could embed the HTML javadoc in view mode with an iframe (or using getURLContent API), or just link to it with the zipexplorer plugin. I think this would make it easier for developers to find out the documentation for the exact version they are running, and without the need of an Internet connection. Tell me what you think, Jerome.
On Mar 20, 2009, at 7:01 PM, Jerome Velociter wrote:
Hello devs,
I am thinking it would be good to automatically attach the javadoc generated for XWiki apis (XWiki, Document, Context, Utils, etc) + maybe velocity tools (listtool, mathtool, etc.) in a wiki document of XE at build time. We could embed the HTML javadoc in view mode with an iframe (or using getURLContent API), or just link to it with the zipexplorer plugin.
I think this would make it easier for developers to find out the documentation for the exact version they are running, and without the need of an Internet connection.
Tell me what you think,
I'm not sure. I'd be +1 to do that in XEclipse for sure since XEclipse is our XWiki IDE now. XEclipse also works offline so it looks perfect for your use case. Thanks -Vincent
On Fri, Mar 20, 2009 at 20:37, Vincent Massol <[email protected]> wrote:
On Mar 20, 2009, at 7:01 PM, Jerome Velociter wrote:
Hello devs,
I am thinking it would be good to automatically attach the javadoc generated for XWiki apis (XWiki, Document, Context, Utils, etc) + maybe velocity tools (listtool, mathtool, etc.) in a wiki document of XE at build time. We could embed the HTML javadoc in view mode with an iframe (or using getURLContent API), or just link to it with the zipexplorer plugin.
I think this would make it easier for developers to find out the documentation for the exact version they are running, and without the need of an Internet connection.
Tell me what you think,
I'm not sure. I'd be +1 to do that in XEclipse for sure since XEclipse is our XWiki IDE now. XEclipse also works offline so it looks perfect for your use case.
Definitely +1 for having api doc in XEclipse. Now for the wiki itself it sounds a good idea too, it's not useless for sure. Note that we generate the javadoc only for a release so we would not get it on a SNAPSHOT build.
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
I believe many of us are using different IDEs as well so it would make a huge lot of sense to actually support, by how-tos, different IDEs for editing velocity and Groovy into this linking. A simple solution to go in the direction of Jérôme would be to plug it in the code view? (which anyways is not exactly the source). At least it would be a self-contained view that would be useful independent of the IDE. paul Le 20-mars-09 à 23:17, Thomas Mortagne a écrit :
On Fri, Mar 20, 2009 at 20:37, Vincent Massol <[email protected]> wrote:
On Mar 20, 2009, at 7:01 PM, Jerome Velociter wrote:
Hello devs,
I am thinking it would be good to automatically attach the javadoc generated for XWiki apis (XWiki, Document, Context, Utils, etc) + maybe velocity tools (listtool, mathtool, etc.) in a wiki document of XE at build time. We could embed the HTML javadoc in view mode with an iframe (or using getURLContent API), or just link to it with the zipexplorer plugin.
I think this would make it easier for developers to find out the documentation for the exact version they are running, and without the need of an Internet connection.
Tell me what you think,
Vincent Massol wrote:
On Mar 20, 2009, at 7:01 PM, Jerome Velociter wrote:
Hello devs,
I am thinking it would be good to automatically attach the javadoc generated for XWiki apis (XWiki, Document, Context, Utils, etc) + maybe velocity tools (listtool, mathtool, etc.) in a wiki document of XE at build time. We could embed the HTML javadoc in view mode with an iframe (or using getURLContent API), or just link to it with the zipexplorer plugin.
I think this would make it easier for developers to find out the documentation for the exact version they are running, and without the need of an Internet connection.
Tell me what you think,
I'm not sure. I'd be +1 to do that in XEclipse for sure since XEclipse is our XWiki IDE now. XEclipse also works offline so it looks perfect for your use case.
I agree it makes a lot of senses in XEclipse. But, how do you tight the version of XWiki to the XEclipse instance ? Even for this use case I think the best is that XEclipse retrieves and download the API from the wiki for each connection, so that you get a documentation matching the wiki you are editing. Jerome.
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
participants (4)
-
Jerome Velociter -
Paul Libbrecht -
Thomas Mortagne -
Vincent Massol