Cedric Beust has announced Doclipse, an Eclipse plug-in to help you write Java source files with Javadoc tags, either for documentation purposes or to be processed by a tool such as EJBGen or XDoclet.
Doclipse announcement
Doclipse home page
-
Announcing Doclipse: JavaDoc tag plug-in for Eclipse (24 messages)
- Posted by: Dion Almaer
- Posted on: June 16 2004 07:51 EDT
Threaded Messages (24)
- Great! by marc schipperheyn on June 16 2004 08:03 EDT
- Sweet! by Ryan Breidenbach on June 16 2004 09:37 EDT
- Do you have xdoclet definition files ? by ping Lu on June 16 2004 10:24 EDT
- Sweet! by Cedric Beust on June 16 2004 10:26 EDT
- Announcing Doclipse: JavaDoc tag plug-in for Eclipse by Aslak Hellesøy on June 16 2004 14:11 EDT
- New version of Doclipse by Cedric Beust on June 16 2004 19:12 EDT
- See also JBoss IDE by Renaud Waldura on June 16 2004 19:18 EDT
- Doclipse by Cedric Beust on June 16 2004 20:25 EDT
- Doclipse - latest version is not working. by beton beton on June 18 2004 01:24 EDT
- See also JBoss IDE by Frank Bolander on June 16 2004 22:16 EDT
-
XDoclet tags by Craig Walls on June 17 2004 10:08 EDT
-
you forgot something by ping Lu on June 18 2004 01:54 EDT
-
you forgot something by beton beton on June 18 2004 02:32 EDT
-
you forgot something by Craig Walls on June 18 2004 02:46 EDT
-
unsupported targets by Craig Walls on June 18 2004 03:26 EDT
-
unsupported targets by Cedric Beust on June 18 2004 03:33 EDT
- unsupported targets by Craig Walls on June 18 2004 03:41 EDT
-
unsupported targets by beton beton on June 18 2004 04:27 EDT
-
unsupported targets by Cedric Beust on June 18 2004 06:50 EDT
- unsupported targets by beton beton on June 18 2004 10:42 EDT
-
unsupported targets by Cedric Beust on June 18 2004 06:50 EDT
-
unsupported targets by Cedric Beust on June 18 2004 03:33 EDT
- you forgot something by beton beton on June 18 2004 04:25 EDT
-
unsupported targets by Craig Walls on June 18 2004 03:26 EDT
-
you forgot something by Craig Walls on June 18 2004 02:46 EDT
-
you forgot something by beton beton on June 18 2004 02:32 EDT
-
you forgot something by ping Lu on June 18 2004 01:54 EDT
-
XDoclet tags by Craig Walls on June 17 2004 10:08 EDT
- Doclipse by Cedric Beust on June 16 2004 20:25 EDT
- Nice one! by Bruno Girin on June 21 2004 07:47 EDT
- Nice one! by Cedric Beust on June 21 2004 13:12 EDT
- help with doeclipse plz!! by Asim Hussain on December 17 2005 23:13 EST
-
Great![ Go to top ]
- Posted by: marc schipperheyn
- Posted on: June 16 2004 08:03 EDT
- in response to Dion Almaer
Just what I've been waiting for! -
Sweet![ Go to top ]
- Posted by: Ryan Breidenbach
- Posted on: June 16 2004 09:37 EDT
- in response to Dion Almaer
Very nice Cedric. Took me all of one minute to integrate our custom XDoclet tags. The only thing I noticed is I got a nasty error message when I pressed Ctrl+Space in the comments *before* I typed the @ symbol. Besides that - works like a champ. Not bad for a 0.0.1 release :-)
Ryan -
Do you have xdoclet definition files ?[ Go to top ]
- Posted by: ping Lu
- Posted on: June 16 2004 10:24 EDT
- in response to Ryan Breidenbach
Do you have xdoclet definition files? I am lazy:) -
Sweet![ Go to top ]
- Posted by: Cedric Beust
- Posted on: June 16 2004 10:26 EDT
- in response to Ryan Breidenbach
Guys, feel free to send me your definition files and I will integrate them in the distribution. I have quite a few enhancements in mind.
The error parsing is very crude at this point so if you make a typo in your XML file, for example, it will probably very silently fail. I will fix that very soon.
Stay tuned!
--
Cedric -
Announcing Doclipse: JavaDoc tag plug-in for Eclipse[ Go to top ]
- Posted by: Aslak Hellesøy
- Posted on: June 16 2004 14:11 EDT
- in response to Dion Almaer
Good stuff Cedric!
This is something I have wanted to do for a long while, but never got around to.
Does anyone know if IDEA's openapi makes it possible to write a similar plugin? One that suggest tags based on context? Last time I checked the openapi didn't support this. (I'm NOT thinking about the low-level context-less tag support IDEA already has). -
New version of Doclipse[ Go to top ]
- Posted by: Cedric Beust
- Posted on: June 16 2004 19:12 EDT
- in response to Aslak Hellesøy
I just uploaded a new version of Doclipse, which now contains a definition file for Hibernate (thanks Ryan!) tags and also an improved preference page that allows you deselect files individually.
You should delete the previous directory of the plug-in before installing this one (the directory inside the zip no longer contains the version number, which makes things simpler for now). -
See also JBoss IDE[ Go to top ]
- Posted by: Renaud Waldura
- Posted on: June 16 2004 19:18 EDT
- in response to Dion Almaer
This functionality is also offered by JBoss IDE, a suite of Eclipse plugins targeted at the JBoss platform.
See http://www.jboss.org/developers/projects/jboss/jbosside.jsp
and page 10 of the JBoss IDE Tutorial:
http://aleron.dl.sourceforge.net/sourceforge/jboss/Tutorial-1.2.2.pdf -
Doclipse[ Go to top ]
- Posted by: Cedric Beust
- Posted on: June 16 2004 20:25 EDT
- in response to Renaud Waldura
I created a mailing-list: http://groups.yahoo.com/group/doclipse/
I have also received definition files for Struts, SOAP and AXIS. I'll upload the new version soon. -
Doclipse - latest version is not working.[ Go to top ]
- Posted by: beton beton
- Posted on: June 18 2004 13:24 EDT
- in response to Cedric Beust
Eclipse cannot create the preference page due to the ClassNotFoundException : DoclipsePreferencePage. -
See also JBoss IDE[ Go to top ]
- Posted by: Frank Bolander
- Posted on: June 16 2004 22:16 EDT
- in response to Renaud Waldura
You can also use it for any other module that is supported by XDoclet. -
XDoclet tags[ Go to top ]
- Posted by: Craig Walls
- Posted on: June 17 2004 22:08 EDT
- in response to Frank Bolander
You can also use it for any other module that is supported by XDoclet.
I just sent Cedric the Doclipse files for all of XDoclet 1.2.1's modules. In case you want to use them before he incorporates them into the next Doclipse release, you can find them here. The ZIP file also includes an XSLT file that I used to transform XDoclet's own xtags.xml files (used to generate XDoclet's documentation) into Doclipse files. -
you forgot something[ Go to top ]
- Posted by: ping Lu
- Posted on: June 18 2004 13:54 EDT
- in response to Craig Walls
you need add <description>EJB XDoclet tags</description> on every xml files, otherwise, it doesn't work -
you forgot something[ Go to top ]
- Posted by: beton beton
- Posted on: June 18 2004 14:32 EDT
- in response to ping Lu
I have downloaded the latest xip file.
Do you mean that I have to modify each xml file from distribution?!
Cedric do you have any comments on this?
Thank you. -
you forgot something[ Go to top ]
- Posted by: Craig Walls
- Posted on: June 18 2004 14:46 EDT
- in response to beton beton
I have downloaded the latest xip file.Do you mean that I have to modify each xml file from distribution?!Cedric do you have any comments on this?Thank you.
It seems that the problem has nothing to do with the "description" tag as was suggested. The XML files work for me as-is...unless I try them on my XP box.
You see, I generated the latest versions on my Powerbook last night and they worked fine. After reading this post, I tried them on my XP box at work and they didn't work. But, if I open them up in my text-editor and resave them, they work fine.
I'm not sure what the deal is. I thought it might be end-of-line characters, but a quick look at the files didn't support that theory. I'll keep looking and let you know. -
unsupported targets[ Go to top ]
- Posted by: Craig Walls
- Posted on: June 18 2004 15:26 EDT
- in response to Craig Walls
It seems that the problem is only with the following XML files: jmx.xml, jdo.xml, tjdo.xml, solarmetric.xml, and xdoclet.xml. If you eliminate these 5 files everything else works fine.
So, what's so special about these? Well, for starters all of them except for jmx.xml have attributes where target="field". And, jmx.xml has attributes where target="constructor". I'm guessing that Doclipse only supports target="method" and target="class". -
unsupported targets[ Go to top ]
- Posted by: Cedric Beust
- Posted on: June 18 2004 15:33 EDT
- in response to Craig Walls
Right, I will add support for constructor and field very soon. In the meantime, just deselect the files that don't work and you should be fine.
New release is imminent with completion on tag name, attribute and attribute values.
--
Cedric -
unsupported targets[ Go to top ]
- Posted by: Craig Walls
- Posted on: June 18 2004 15:41 EDT
- in response to Cedric Beust
Right, I will add support for constructor and field very soon. In the meantime, just deselect the files that don't work and you should be fine.New release is imminent with completion on tag name, attribute and attribute values.-- Cedric
Actually, you have to do more than just deselect them...you need to remove those files completely. You'll get an error when you pull up the preferences window if it sees those files laying around. -
unsupported targets[ Go to top ]
- Posted by: beton beton
- Posted on: June 18 2004 16:27 EDT
- in response to Craig Walls
I tried the latest zip file from Cedric site on my linux box.
So I suspect it is either the file format of the code itself.
Eclipse log says something about: ClassNotFoundException as I mentioned ealier. -
unsupported targets[ Go to top ]
- Posted by: Cedric Beust
- Posted on: June 18 2004 18:50 EDT
- in response to beton beton
ClassNotFound is not good... Can you email me your log?
Let's continue the discussion on the doclipse mailing-list: http://www.yahoogroups.com/group/doclipse
--
Cedric -
unsupported targets[ Go to top ]
- Posted by: beton beton
- Posted on: June 18 2004 22:42 EDT
- in response to Cedric Beust
Your first version used to work ok on my linux/eclipse environment.
Something has changed snce then I guess.
I will try to signup to yahoo. -
you forgot something[ Go to top ]
- Posted by: beton beton
- Posted on: June 18 2004 16:25 EDT
- in response to Craig Walls
It may be the file format - I am trying out on my Linux box.
I will try to hack my way out for now. -
Nice one![ Go to top ]
- Posted by: Bruno Girin
- Posted on: June 21 2004 07:47 EDT
- in response to Dion Almaer
Nice one Cedric!
It took me a whole minute to download and install the plugin in Eclipse 3 and another 2 to create a first draft of a custom doclipse XML that declares the custom tags we use with our MDA tool. So now when I update our MDA templates and add a new tag, everybody on the team will be able to use it in Eclipse by just updating the file from CVS. It will definitely save us time and typos.
Thanks
Bruno -
Nice one![ Go to top ]
- Posted by: Cedric Beust
- Posted on: June 21 2004 13:12 EDT
- in response to Bruno Girin
Nice one Cedric!It took me a whole minute to download and install the plugin in Eclipse 3 and another 2 to create a first draft of a custom doclipse XML that declares the custom tags we use with our MDA tool. So now when I update our MDA templates and add a new tag, everybody on the team will be able to use it in Eclipse by just updating the file from CVS. It will definitely save us time and typos.ThanksBruno
Happy to hear that, Bruno.
I just posted a better version on the mailing-list and a few more improvements will be coming very soon:
- Completion on attributes and attribute values
- Constrained attribute values, e.g. "true" and "false"
- Documentation for tags and attributes during completion
- etc...
--
Cedric -
help with doeclipse plz!![ Go to top ]
- Posted by: Asim Hussain
- Posted on: December 17 2005 23:13 EST
- in response to Dion Almaer
hi just downloaded and tried to install doeclipse but it is not being
read by eclipse 3.1.1
steps taken
1. downloaded doeclipse zip file
2. unzipped it to eclipse/plugin directory (so I have a folder called
com.beust.doclipse_0.7.0)
3. closed eclipse
4. ran eclipse
5. went to windows and preference, I do not see doeclipse in the left
window!!
any help would be appreciated.
thanks