Writing site documenation with eclipse
I'm starting to write documentation for my maven project. Which format (apt,xdoc,..?) and which editor is available for eclipse? The documentation is very code-centric so any tool that helps me refering to Class names (and even validates it) would be helpful. Also, xDoc != XDoc, right? https://github.com/RvonMassow/xDoc/blob/master/README.textile http://maven.apache.org/doxia/references/xdoc-format.html Cheers, Jan - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: Writing site documenation with eclipse
choosing format is a question of taste: some prefer apt, some prefer xdoc, you'll have to make your own choice for the editor, there is a good Doxia Eclipse plugin [1] It help writing wiki syntax, or preview, but there is nothing tied to code references. Regards, Hervé [1] http://maven.apache.org/doxia/doxia-ide/eclipse/usage.html Le lundi 16 juillet 2012 10:45:44 Jan Torben Heuer a écrit : I'm starting to write documentation for my maven project. Which format (apt,xdoc,..?) and which editor is available for eclipse? The documentation is very code-centric so any tool that helps me refering to Class names (and even validates it) would be helpful. Also, xDoc != XDoc, right? https://github.com/RvonMassow/xDoc/blob/master/README.textile http://maven.apache.org/doxia/references/xdoc-format.html Cheers, Jan - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: Writing site documenation with eclipse
Greetings, On Mon, Jul 16, 2012 at 9:13 AM, Hervé BOUTEMY herve.bout...@free.fr wrote: for the editor, there is a good Doxia Eclipse plugin [1] [1] http://maven.apache.org/doxia/doxia-ide/eclipse/usage.html Except that the Eclipse installation sites don't work.. http://maven.apache.org/doxia/doxia-ide/eclipse/eclipse https://builds.apache.org/view/M-R/view/Maven/job/doxia-eclipse-editor/ws/doxia-ide-eclipse/eclipse-plugins/features/org.apache.maven.doxia.ide.eclipse.feature/target/site/ And it isn't in Eclipse Marketplace.. -Jesse -- There are 10 types of people in this world, those that can read binary and those that can not. - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
Re: Writing site documenation with eclipse
Le lundi 16 juillet 2012 10:13:06 Jesse Farinacci a écrit : Greetings, On Mon, Jul 16, 2012 at 9:13 AM, Hervé BOUTEMY herve.bout...@free.fr wrote: for the editor, there is a good Doxia Eclipse plugin [1] [1] http://maven.apache.org/doxia/doxia-ide/eclipse/usage.html Except that the Eclipse installation sites don't work.. http://maven.apache.org/doxia/doxia-ide/eclipse/eclipse ok, this one isn't here https://builds.apache.org/view/M-R/view/Maven/job/doxia-eclipse-editor/ws/do xia-ide-eclipse/eclipse-plugins/features/org.apache.maven.doxia.ide.eclipse. feature/target/site/ but this one is working perfectly for me And it isn't in Eclipse Marketplace.. do you know how to add something to Eclipse Marketplace? -Jesse - To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org