[Jrst-user] Javadoc and reStructuredText
Hi all, I have googled the whole internet for a Java based reStructuredText parser and it seems that your JRST project is the only Java based reStructuredText parser in the universe! I am looking for a Doclet or other tool to that enables the use of reStructuredText in javadoc comments. Does anybody know if such tool has been created, based on JRST? Or are there any plans in this project to create such a tool or add-on? I am also looking for a Maven plugin to convert reStructuredText files into XML. Something similar to the maven-apt-plugin (http://maven-plugins.sourceforge.net/maven-aptdoc-plugin). Does anybody know if there is something like that or if there is anybody who is having plans for starting a project for it? If so, I am willing to help or even start such a project myself. Thanks in advance, Peter van de Hoef
On Sat, 30 Apr 2005 23:18:39 +0200 Peter van de Hoef <pvdhoef@springsite.com> wrote:
Hi all,
Hi,
I have googled the whole internet for a Java based reStructuredText parser and it seems that your JRST project is the only Java based reStructuredText parser in the universe!
I have looking for Java based reStructuredText parser, and i never found it :( If in futur you find a parser, email me :)
I am looking for a Doclet or other tool to that enables the use of reStructuredText in javadoc comments. Does anybody know if such tool has been created, based on JRST? Or are there any plans in this project to create such a tool or add-on?
no, there are no support for Javadoc in RST :(. But this is a good idea. I put it in the TODO list :)
I am also looking for a Maven plugin to convert reStructuredText files into XML. Something similar to the maven-apt-plugin (http://maven-plugins.sourceforge.net/maven-aptdoc-plugin).
Does anybody know if there is something like that or if there is anybody who is having plans for starting a project for it? If so, I am willing to help or even start such a project myself.
We have this in maven-topia-plugin. But perhaps you must extract topia:docs rules in new plugin. If you do that send me the plugin, i put it in CVS. http://topia.labs.libre-entreprise.org/maven-topia-plugin/ to use this plugin, you juste install it, and add next lines in your maven.xml. <preGoal name="site"> <attainGoal name="topia:docs"/> </preGoal> to install the plugin add this site in your maven.repo.remote http://lutinbuilder.labs.libre-entreprise.org/maven/ and type maven -DartifactId=maven-topia-plugin -DgroupId=lutinlib -Dversion=0.30 plugin:download after All file in /doc directory with .rst extension are coverted in xdoc file. You can use it in your navigation.xml or other. You can use image tag in the rst, and put image in /doc directory or subdirectory. i hope this help you. ps: there are a little bug in rst parser, but 2 space before all Title. -- Benjamin -------------------- email: poussin@codelutin.com () campagne du ruban ascii http://www.codelutin.com /\ pour les mails en ascii
On Sat, 30 Apr 2005 23:18:39 +0200 Peter van de Hoef <pvdhoef@springsite.com> wrote:
Hi all,
Hi, we have completly rewrite JRst. this new version have better design and permit to add new feature easly. (http://jrst.labs.libre-entreprise.org/)
I have googled the whole internet for a Java based reStructuredText parser and it seems that your JRST project is the only Java based reStructuredText parser in the universe!
I am looking for a Doclet or other tool to that enables the use of reStructuredText in javadoc comments. Does anybody know if such tool has been created, based on JRST? Or are there any plans in this project to create such a tool or add-on?
We implements this feature during next summer if we have time.
I am also looking for a Maven plugin to convert reStructuredText files into XML. Something similar to the maven-apt-plugin (http://maven-plugins.sourceforge.net/maven-aptdoc-plugin).
Does anybody know if there is something like that or if there is anybody who is having plans for starting a project for it? If so, I am willing to help or even start such a project myself.
We have maven2 plugin for JRst http://jrst.labs.libre-entreprise.org/maven-jrst-plugin/. This plugin, generate xdoc file in new directory, this directory can be used by maven-site-plugin. if you want more information, you can send email on this list. -- Benjamin -------------------- tél: +33 (0) 2 40 50 29 28 email: poussin@codelutin.com () campagne du ruban ascii http://www.codelutin.com /\ pour les mails en ascii
Hello Benjamin, Sounds great! I have been working on some other issues lately so this topic has moved a bit to the background for me. But if I can find some time I will certainly pick this up again. The ability to format JavaDoc comments as reStructuredText would be great. I allways find it very cumbersome to use HTML in JavaDoc comments so I guess this will certainly be welcomed by a lot of Java programmers. Thanks for your update. Greetings, Peter Benjamin POUSSIN wrote:
On Sat, 30 Apr 2005 23:18:39 +0200 Peter van de Hoef <pvdhoef@springsite.com> wrote:
Hi all,
Hi,
we have completly rewrite JRst. this new version have better design and permit to add new feature easly. (http://jrst.labs.libre-entreprise.org/)
I have googled the whole internet for a Java based reStructuredText parser and it seems that your JRST project is the only Java based reStructuredText parser in the universe!
I am looking for a Doclet or other tool to that enables the use of reStructuredText in javadoc comments. Does anybody know if such tool has been created, based on JRST? Or are there any plans in this project to create such a tool or add-on?
We implements this feature during next summer if we have time.
I am also looking for a Maven plugin to convert reStructuredText files into XML. Something similar to the maven-apt-plugin (http://maven-plugins.sourceforge.net/maven-aptdoc-plugin).
Does anybody know if there is something like that or if there is anybody who is having plans for starting a project for it? If so, I am willing to help or even start such a project myself.
We have maven2 plugin for JRst http://jrst.labs.libre-entreprise.org/maven-jrst-plugin/.
This plugin, generate xdoc file in new directory, this directory can be used by maven-site-plugin.
if you want more information, you can send email on this list.
-- Benjamin -------------------- tél: +33 (0) 2 40 50 29 28 email: poussin@codelutin.com () campagne du ruban ascii http://www.codelutin.com /\ pour les mails en ascii
participants (3)
-
Benjamin POUSSIN -
Peter van de Hoef -
Peter van de Hoef