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

Doxygen plugin

<< < (43/53) > >>

Cryogen:

 Hi Olly,


--- Quote from: ollydbg on September 04, 2010, 08:45:24 am ---Here is my test on doxygen, which I just right click on the function name and would like to add the block comment

So,
1, I guess the function parameter in multiply lines are not supported.
2, I think we don't need to add the "type" information , so "\param actual" is enough.

any comments?


--- End quote ---

1. No, it's not, I'm afraid and I was unable to make it work.

2. I don't know what you mean, here.

Cheers.

ollydbg:

--- Quote from: Cryogen on September 05, 2010, 11:53:18 pm ---2. I don't know what you mean, here.

--- End quote ---
thanks for the reply and sorry for my bad English.

I mean that


--- Code: ---/** \brief
         *
         * \param actual const wxString&
         * \param components std::queue<ParserComponent>&
         * \return size_t
         *
         */                                                     
        size_t BreakUpComponents(const wxString& actual, std::queue<ParserComponent>& components);
--- End code ---

should be:

--- Code: ---/** \brief
         *
         * \param actual
         * \param components
         * \return size_t
         *
         */                                                     
        size_t BreakUpComponents(const wxString& actual, std::queue<ParserComponent>& components);
--- End code ---
Not type information about the parameter is need. (this is most comment style in codeblocks' source).

Cryogen:

 Hi Guys,

I am happy to report that, at long last, I now have a .cbplugin for 10.5 on Windows. It's available from:

http://wxsmithaddons.sourceforge.net/doxyblocks.html

Many thanks to my main man killerbot for building it. I'm sure it will be appreciated by those who have been waiting for it. I will try and coerce Jens into making one for Linux to complete the set.

Cheers,

 Gary.

Cryogen:

--- Quote from: ollydbg on September 06, 2010, 01:15:43 am ---
--- Quote from: Cryogen on September 05, 2010, 11:53:18 pm ---2. I don't know what you mean, here.

--- End quote ---
thanks for the reply and sorry for my bad English.

I mean that


--- Code: ---/** \brief
         *
         * \param actual const wxString&
         * \param components std::queue<ParserComponent>&
         * \return size_t
         *
         */                                                     
        size_t BreakUpComponents(const wxString& actual, std::queue<ParserComponent>& components);
--- End code ---

should be:

--- Code: ---/** \brief
         *
         * \param actual
         * \param components
         * \return size_t
         *
         */                                                     
        size_t BreakUpComponents(const wxString& actual, std::queue<ParserComponent>& components);
--- End code ---
Not type information about the parameter is need. (this is most comment style in codeblocks' source).

--- End quote ---

OK, got it. Please don't apologise, my brain's getting old. I think that what is "most common" probably depends on experience and other factors. There's no way DoxyBlocks can ever deal with every possible code format or please everyone. I seem to remember getting the existing form from doxyblocks docs but I see that it's different in the current version. Maybe it changed or maybe it came from the original script, I really can't recall. If there was a consensus that a specific format was wanted, we could certainly change it. What you can do is modify your copy to produce the output you want, though. It should be fairly straightforward and I'm happy to help you if required. Just yell.

Gary.

killerbot:
Hi Gary,
to be honest this is the first time is saw that the type information was added.

My feeling is, no need to specify the type information (another thing to change when the parameter would become a different type).

Navigation

[0] Message Index

[#] Next page

[*] Previous page