Doxygen

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

Doxygen

Mark B
Hi all,

I'm working on improvement of Doxygen support in CDT. We need to add new
options in order to let the user fine tune the behavior. At the moment I
could see four or five options like:

1) Use structured commands, @class, @struct and so on;
2) Use javadoc style for tags '@' instead of '\'
3) Use different style for enums like //< or /**< and so on
4) Use always @brief or not
5) If brief is enabled, an option for a new line or not after for
detailed description

The question: where should we add these options? The only option we have
now is under C/C++->Editor where the user can  switch the doc owner for
project/workspace. Maybe a new page C/C++->Doxygen?? Or maybe adding the
options under the comment section of formatter? In JDT Javadoc options
are there but Java and C/C++ are quite different because Javadoc is
built-in, Doxygen is an external tool not strict related with C/C++.
If we not add the options to the formatter (where I'm more familiar
with), is there any common framework to manage options in CDT about
load/save? I was looking at DocCommentOwnerManager but I don't know if
the right class.
Any hint is welcome.

Regards.
_______________________________________________
cdt-dev mailing list
[hidden email]
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/cdt-dev
Reply | Threaded
Open this post in threaded view
|

Re: Doxygen

Marc-Andre Laperle-3
Would it actually do anything when you do the Format command? If not, I think maybe C/C++->Editor > Doxygen might be OK or maybe C/C++ > Code Style > Doxygen

Then Code Style should also be configurable per project, but that’s another issue…

Cheers,
Marc-André

> On Jan 6, 2020, at 5:58 AM, marco <[hidden email]> wrote:
>
> Hi all,
>
> I'm working on improvement of Doxygen support in CDT. We need to add new options in order to let the user fine tune the behavior. At the moment I could see four or five options like:
>
> 1) Use structured commands, @class, @struct and so on;
> 2) Use javadoc style for tags '@' instead of '\'
> 3) Use different style for enums like //< or /**< and so on
> 4) Use always @brief or not
> 5) If brief is enabled, an option for a new line or not after for detailed description
>
> The question: where should we add these options? The only option we have now is under C/C++->Editor where the user can  switch the doc owner for project/workspace. Maybe a new page C/C++->Doxygen?? Or maybe adding the options under the comment section of formatter? In JDT Javadoc options are there but Java and C/C++ are quite different because Javadoc is built-in, Doxygen is an external tool not strict related with C/C++.
> If we not add the options to the formatter (where I'm more familiar with), is there any common framework to manage options in CDT about load/save? I was looking at DocCommentOwnerManager but I don't know if the right class.
> Any hint is welcome.
>
> Regards.
> _______________________________________________
> cdt-dev mailing list
> [hidden email]
> To change your delivery options, retrieve your password, or unsubscribe from this list, visit
> https://www.eclipse.org/mailman/listinfo/cdt-dev

_______________________________________________
cdt-dev mailing list
[hidden email]
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/cdt-dev
Reply | Threaded
Open this post in threaded view
|

Re: Doxygen

Mark B
No, it wouldn't do anything, it's the reason why I had doubt about it. At the moment I'm trying to insert new options under C/C++->Editor where there's already the option to switch document owner and this option block is used in the general preferences and in the project settings but it would be easy to change.

I'm trying to understand how to manage the properties correctly. I was thinking to add a getPreferences() to the DocCommentOwnerManager in order to take the instaceScope preferences over projectscope preferences, but I'm still trying to understand because I didn't understand well how to manage workspace vs project preferences and their default initialization.

Il gio 9 gen 2020, 06:54 Marc-Andre Laperle <[hidden email]> ha scritto:
Would it actually do anything when you do the Format command? If not, I think maybe C/C++->Editor > Doxygen might be OK or maybe C/C++ > Code Style > Doxygen

Then Code Style should also be configurable per project, but that’s another issue…

Cheers,
Marc-André

> On Jan 6, 2020, at 5:58 AM, marco <[hidden email]> wrote:
>
> Hi all,
>
> I'm working on improvement of Doxygen support in CDT. We need to add new options in order to let the user fine tune the behavior. At the moment I could see four or five options like:
>
> 1) Use structured commands, @class, @struct and so on;
> 2) Use javadoc style for tags '@' instead of '\'
> 3) Use different style for enums like //< or /**< and so on
> 4) Use always @brief or not
> 5) If brief is enabled, an option for a new line or not after for detailed description
>
> The question: where should we add these options? The only option we have now is under C/C++->Editor where the user can  switch the doc owner for project/workspace. Maybe a new page C/C++->Doxygen?? Or maybe adding the options under the comment section of formatter? In JDT Javadoc options are there but Java and C/C++ are quite different because Javadoc is built-in, Doxygen is an external tool not strict related with C/C++.
> If we not add the options to the formatter (where I'm more familiar with), is there any common framework to manage options in CDT about load/save? I was looking at DocCommentOwnerManager but I don't know if the right class.
> Any hint is welcome.
>
> Regards.
> _______________________________________________
> cdt-dev mailing list
> [hidden email]
> To change your delivery options, retrieve your password, or unsubscribe from this list, visit
> https://www.eclipse.org/mailman/listinfo/cdt-dev

_______________________________________________
cdt-dev mailing list
[hidden email]
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/cdt-dev

_______________________________________________
cdt-dev mailing list
[hidden email]
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/cdt-dev
Reply | Threaded
Open this post in threaded view
|

Re: Doxygen

Alexander Fedorov
Mark,

There is something strange written in the DocCommentOwnerManager regarding work with Preferences. That is important you need an IProject to access the project scope while working with preferences.
Here is the snippet from EMF that can give you an idea what to do:

      IProject project ...
      String value =
        Platform.getPreferencesService().getString
          (Platform.PI_RUNTIME,
           Platform.PREF_LINE_SEPARATOR,
           SYSTEM_PROPERTY_LINE_SEPARATOR,
           new IScopeContext[] { new ProjectScope(project), INSTANCE_SCOPE });
   

Regards,
AF


09.01.2020 9:07, Mark B пишет:
No, it wouldn't do anything, it's the reason why I had doubt about it. At the moment I'm trying to insert new options under C/C++->Editor where there's already the option to switch document owner and this option block is used in the general preferences and in the project settings but it would be easy to change.

I'm trying to understand how to manage the properties correctly. I was thinking to add a getPreferences() to the DocCommentOwnerManager in order to take the instaceScope preferences over projectscope preferences, but I'm still trying to understand because I didn't understand well how to manage workspace vs project preferences and their default initialization.

Il gio 9 gen 2020, 06:54 Marc-Andre Laperle <[hidden email]> ha scritto:
Would it actually do anything when you do the Format command? If not, I think maybe C/C++->Editor > Doxygen might be OK or maybe C/C++ > Code Style > Doxygen

Then Code Style should also be configurable per project, but that’s another issue…

Cheers,
Marc-André

> On Jan 6, 2020, at 5:58 AM, marco <[hidden email]> wrote:
>
> Hi all,
>
> I'm working on improvement of Doxygen support in CDT. We need to add new options in order to let the user fine tune the behavior. At the moment I could see four or five options like:
>
> 1) Use structured commands, @class, @struct and so on;
> 2) Use javadoc style for tags '@' instead of '\'
> 3) Use different style for enums like //< or /**< and so on
> 4) Use always @brief or not
> 5) If brief is enabled, an option for a new line or not after for detailed description
>
> The question: where should we add these options? The only option we have now is under C/C++->Editor where the user can  switch the doc owner for project/workspace. Maybe a new page C/C++->Doxygen?? Or maybe adding the options under the comment section of formatter? In JDT Javadoc options are there but Java and C/C++ are quite different because Javadoc is built-in, Doxygen is an external tool not strict related with C/C++.
> If we not add the options to the formatter (where I'm more familiar with), is there any common framework to manage options in CDT about load/save? I was looking at DocCommentOwnerManager but I don't know if the right class.
> Any hint is welcome.
>
> Regards.
> _______________________________________________
> cdt-dev mailing list
> [hidden email]
> To change your delivery options, retrieve your password, or unsubscribe from this list, visit
> https://www.eclipse.org/mailman/listinfo/cdt-dev

_______________________________________________
cdt-dev mailing list
[hidden email]
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/cdt-dev

_______________________________________________
cdt-dev mailing list
[hidden email]
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/cdt-dev


_______________________________________________
cdt-dev mailing list
[hidden email]
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/cdt-dev