Doxygen plugin

[Cryogen]

 Hi Olly,

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?

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]

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

thanks for the reply and sorry for my bad English.

I mean that

Code: [Select]

/** \brief
         *
         * \param actual const wxString&
         * \param components std::queue<ParserComponent>&
         * \return size_t
         *
         */                                                     
        size_t BreakUpComponents(const wxString& actual, std::queue<ParserComponent>& components);
should be:

Code: [Select]

/** \brief
         *
         * \param actual
         * \param components
         * \return size_t
         *
         */                                                     
        size_t BreakUpComponents(const wxString& actual, std::queue<ParserComponent>& components);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]

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

thanks for the reply and sorry for my bad English.

I mean that

Code: [Select]

/** \brief
         *
         * \param actual const wxString&
         * \param components std::queue<ParserComponent>&
         * \return size_t
         *
         */                                                     
        size_t BreakUpComponents(const wxString& actual, std::queue<ParserComponent>& components);
should be:

Code: [Select]

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

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).

[MortenMacFly]

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

I agree here, as usually Doxygen handles that for you anyways. I'd say the variable name is enough.

[koso]

Hi,

its hard to describe ... but is it possible to configure plugin (update source) so that inserting block comment is one unite editor action and can be removed using one "undo"? Now it needs much more undo operations to return to the state before inserting comment, which is especially annoying in case of accidental comment insertion

[jens]

Hi,

its hard to describe ... but is it possible to configure plugin (update source) so that inserting block comment is one unite editor action and can be removed using one "undo"? Now it needs much more undo operations to return to the state before inserting comment, which is especially annoying in case of accidental comment insertion

Yes it's quite easy.

I attach a patch against actual trunk.

@Gary:
can I commit the patch or do you want to review it and update your svn-repo first, if you accept the patch ?

[Cryogen]

 Hi Jens,

No, you go ahead. My SF repo. is defunct, now.

Thanks.

[jens]

 Hi Jens,

No, you go ahead. My SF repo. is defunct, now.

Thanks.

Done in svn r6840 .

[NefX]

I agree here, as usually Doxygen handles that for you anyways. I'd say the variable name is enough.

Yeah, you can see type name already so it's not needed.

Two things I would like to see -  code completion displaying doxygen comments and automatic adding e.g. '///' when making new line (inside doxygen comment).  By the way how to change default hotkeys from this plugin?

[Folco]

First time I use your plugin Cryogen. It's very efficient, good job and thank you !

[Cryogen]

First time I use your plugin Cryogen. It's very efficient, good job and thank you !

[Admin: Removed non-english content.]

I'm glad you found it useful.

Cheers.

[koso]

Hi,

it seems that plugin has problem with commenting multiline function/procedure declarations. It adds block comment, but parameter names (and types) are missing. For example:

Code: [Select]

    /** @brief
     *
     * @param
     * @param
     * @return
     *
     */                             
    void handle_write(const int error,
                      long bytes_transferred)

but I expected this:

Code: [Select]

    /** @brief
     *
     * @param error const int
     * @param bytes_transferred long
     * @return void
     *
     */                             
    void handle_write(const int error, long bytes_transferred)

[Cryogen]

Hi,

it seems that plugin has problem with commenting multiline function/procedure declarations. It adds block comment, but parameter names (and types) are missing. For example:

Yes, quite right. I could find no way to make it accommodate them. I still can't, unfortunately.

The barely useful work-around is to condense the declaration to one line, generate the comment, then revert it.

Cheers.