Developer forums (C::B DEVELOPMENT STRICTLY!) > Plugins development

Doxygen script plugin

<< < (10/14) > >>

ajaywazir:
thanks!
Got it.
Are you planning any upgrades?
e.g to add a DOXY commend based on function prototype
for automatic adding @params (in/out)  etc....rather than typing.

Ajay

jomeggs:
Hi Ajay,

my next goal ist to develop a real CB plugin which should be more customizable regarding all the possible doxygen control parameters. The idea to create automated comments would mean to change the underlying source files, a thing I would never do so far. By the way, in my eyes such comments are rather useless. Better write it by hand so you have the full control to decide, which functions are worth to be commented. I wont be rude, but these automated source documentations uses to be a pest sometimes, a lot of paper or html pages without any information at all.

My (undemanded 8)) advise is, write your comments while your're writing the function itself. This is the moment when all the needed information is still in your head. If you're doing your coments later, you could have forgotten the most interesting parts...

Nevertheless, if you still want to have an autodocumentation (nearly not possible after my claptrap above  :D), have a look t0 the EXTRACT_ALL doxygen option.

ajaywazir:
Hi Jomeggs,
Thanks.
I am with you. My idea was to automate the mundane task of writing function header comments.
The script could possible get @param information from selected test and past it above selection
There are a few eclipse/VS addons like you are planning, which may of help to you.
1. Eclox Doxygen plug in  (Java)
2. Eclipse CDT has builit in support for DOXY comments (Java)
3. DOXYBAR for VS as VS addin. (in CPP)
These can provide you some base line code.
Ajay

jomeggs:
Thanks for your hints. I'll take a deeper look for them before starting my own plugin.

killerbot:

--- Quote from: jomeggs on July 15, 2009, 09:14:54 pm ---
--- Quote from: ollydbg on July 15, 2009, 09:05:03 am ---But it's there in the first post of this thread....

--- End quote ---

Thanks for your help! :lol: :lol: :lol:

I'm thinking about to create a real doxygen-plugin with config options and so on.But before I heave my backside off my beloved sofa, I need to know if that is worth the pain... What are you guys thinking about?

--- End quote ---

Damn right :-)
One of the first plug-in things i started and off course never finished was a Doxygen plug-in.  :?

So you have my support, and maybe it might be nice to have a little roadmap of futures you have in mind.
If we would be able to add them in a safe and stable way we might turn this into a contrib plug-in ...

Cheers.

Navigation

[0] Message Index

[#] Next page

[*] Previous page