Thread: [CEDET-devel] Tag documentation
Brought to you by:
zappo
From: Matthias M. <or...@gm...> - 2012-09-07 10:02:55
|
Hi, I just want to advertise for a package that helps generating documentation string from tags. Package: http://marmalade-repo.org/packages/doctags Sources: https://gitorious.org/doctags Calling `doctags-document-current-tag' with the point inside the following tag: bool operator()(const Segment &a, const Segment &b) const { return dist(a.first, a.second) < dist(b.first, b.second); } inserts: /*! \brief \param a \param b \return */ bool operator()(const Segment &a, const Segment &b) const { return dist(a.first, a.second) < dist(b.first, b.second); } Suggestions, improvements welcome, -- Matthias |
From: Eric M. L. <eri...@gm...> - 2012-09-11 01:15:40
|
Hi Matthias, That looks like a good tool. I had tried using skeleton for srecode a long time ago. It was good for comments, but not quite powerful enough for code generation. The SRecode package has a similar command which you can get at with `srecode-document-insert-comment'. It then tries to figure out the best kind of comment to do. It flips between doxygen or javadoc depending on mode. I wrote the original a while ago, so some of the templates are a bit old-school and could be improved. It also doesn't do Qt, which I see your version handles. You might be able to update the templates for your style of comments. Eric On 09/07/2012 06:02 AM, Matthias Meulien wrote: > Hi, > > I just want to advertise for a package that helps generating > documentation string from tags. > > Package: http://marmalade-repo.org/packages/doctags > Sources: https://gitorious.org/doctags > > Calling `doctags-document-current-tag' with the point inside the > following tag: > > bool > operator()(const Segment&a, const Segment&b) const > { return dist(a.first, a.second)< dist(b.first, b.second); } > > inserts: > > /*! > \brief > > \param a > \param b > \return > */ > bool > operator()(const Segment&a, const Segment&b) const > { return dist(a.first, a.second)< dist(b.first, b.second); } > > Suggestions, improvements welcome, |
From: Matthias M. <or...@gm...> - 2012-09-11 07:34:01
|
> (...) You might be able to update the templates for > your style of comments. I'll try SRecode and hopefully make my package obsolete: SRecode looks far more advanced than my package. Notably, I am interested in the following feature: "If the cursor is in a comment, figure out what kind of comment it is and replace it." . What is the best entry point for SRecode? Source code? GNU Emacs 24.1 is bundled with SRecode but I can't find a word on it in the Info documentation (both Emacs and Semantic)... Thanks, -- Matthias |
From: Eric M. L. <eri...@gm...> - 2012-09-11 11:55:40
|
On 09/11/2012 03:33 AM, Matthias Meulien wrote: >> (...) You might be able to update the templates for >> your style of comments. > > I'll try SRecode and hopefully make my package obsolete: SRecode looks > far more advanced than my package. Notably, I am interested in the > following feature: "If the cursor is in a comment, figure out what kind > of comment it is and replace it." . > > What is the best entry point for SRecode? Source code? > > GNU Emacs 24.1 is bundled with SRecode but I can't find a word on it in > the Info documentation (both Emacs and Semantic)... SRecode is a part of Emacs to support EDE Makefile generation. The extended doc etc is in CEDET in BZR. The doc is in doc/info/srecode.info. If you start with lisp/cedet/srecode/document.el, that is an example srecode application. The templates are in etc/srecode. Most of them are wrappers around doxygen temlates in cpp.srt. You will also find that document.el uses srecode/extract to extract content out of a previously inserted template. That might help figure out what type of comment is already there. Good Luck Eric |