Author Topic: [PATCH] Better support for Doxygen  (Read 3037 times)

Ding Zhaojie

  • Senior Community Member
  • Posts: 191
  • Hero Points: 36
[PATCH] Better support for Doxygen
« on: June 17, 2008, 04:09:33 pm »
I improved the Doxygen support in SE v13 tonight. The patch has not been fully tested and I'm still working on it. So use it at your own risk.

Here are some screen shots showing the improvements:

Display the svn doxygen comments:

BEFORE: UNREADABLE!
AFTER: MUCH better now  ;D

[UPDATED]: Merged @param[in, out] support by MRawlings (Thanks!)
« Last Edit: June 18, 2008, 03:59:30 pm by Ding Zhaojie »

Clark

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 3664
  • Hero Points: 238
Re: [PATCH] Better support for Doxygen
« Reply #1 on: June 18, 2008, 03:51:34 pm »
I'd like to checkout your changes.  Can you post this file either in uncompressed or in .zip or .jar format.

Thanks

Ding Zhaojie

  • Senior Community Member
  • Posts: 191
  • Hero Points: 36
Re: [PATCH] Better support for Doxygen
« Reply #2 on: June 18, 2008, 04:03:35 pm »
I'd like to checkout your changes.  Can you post this file either in uncompressed or in .zip or .jar format.

Thanks

Uploaded, and here is a header file from svn source for testing.

Clark

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 3664
  • Hero Points: 238
Re: [PATCH] Better support for Doxygen
« Reply #3 on: June 19, 2008, 09:31:25 pm »
Thanks for some very useful changes.

I've looked over the code but I'm not quite finished.  What does the following line do/Why is it needed/Give an example.

res = stranslate(res, '', '\*/', 'R');

Wouldn't */ teminate the comment?

Thanks

Ding Zhaojie

  • Senior Community Member
  • Posts: 191
  • Hero Points: 36
Re: [PATCH] Better support for Doxygen
« Reply #4 on: June 20, 2008, 01:30:05 am »
Thanks for some very useful changes.

I've looked over the code but I'm not quite finished.  What does the following line do/Why is it needed/Give an example.

res = stranslate(res, '', '\*/', 'R');

Wouldn't */ teminate the comment?

Thanks


Here is an example:
Code: [Select]
struct tipc_portid {
    __u32 ref;      /**< Port Reference */
    __u32 node;     /**< Node Address */
};

In the original SE it will be displayed as "< Port Reference */".

Clark

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 3664
  • Hero Points: 238
Re: [PATCH] Better support for Doxygen
« Reply #5 on: June 20, 2008, 01:37:08 pm »
Ok, now I see why I was confused.  There seems to be a parsing issue which occurs before this function is ever called.  The trailing "*/" should have already been stripped.  I'm going to checkout out what's going on.

Thanks