Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
RE: [cdt-dev] codan feature

Hi,
The API of the Codan plugins is in a poor condition

Package names:
==============
The plugins org.eclipse.cdt.codan.checkers,
org.eclipse.cdt.codan.checkers.ui
and org.eclipse.cdt.codan.ui do not export any packages. This is
actually
a good thing (== no API). 
These non-api packages should be named 'org.eclipse.cdt.internal....'.

Tooling markup:
===============
* All interfaces of the API need to be marked as @noimplement and
@noextend. 
* Where this is not feasable public interfaces need to be replaced by 
  abstract classes.
* All classes of the API need to be marked @noextend and @noinstantiate.
In
  case clients need to create instances it is better to provide a
factory.

Java Doc:
==========
All of the public API needs to be java-doced.

Initially I had filed
https://bugs.eclipse.org/bugs/show_bug.cgi?id=279740 for that. Markus.

> -----Original Message-----
> From: cdt-dev-bounces@xxxxxxxxxxx 
> [mailto:cdt-dev-bounces@xxxxxxxxxxx] On Behalf Of Alena Laskavaia
> Sent: Wednesday, March 03, 2010 6:12 PM
> To: CDT General developers list.
> Subject: [cdt-dev] codan feature
> Importance: Low
> 
> I added a feature, I called it "Eclipse C/C++ Code Analysis 
> Framework (Codan)" to codan folder, Doug can you please 
> include it in a build?
> Or let me know how to do it. Do we have any wiki or something 
> about it?
> I also have a test project, I don't know how to include it in 
> testing suite... And to include sources for plugins, should I 
> make another feature or they are included automatically somehow?
> _______________________________________________
> cdt-dev mailing list
> cdt-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/cdt-dev
> 


Back to the top